Opened 2 years ago

Closed 2 years ago

#29233 closed defect (fixed)

bootstrap && make distclean broken

Reported by: vbraun Owned by:
Priority: blocker Milestone: sage-9.1
Component: build: configure Keywords:
Cc: dimpase, embray, jhpalmieri Merged in:
Authors: Matthias Koeppe Reviewers: Dima Pasechnik
Report Upstream: N/A Work issues:
Branch: 0dc97db (Commits, GitHub, GitLab) Commit: 0dc97dbb12fcde2981cc0a4ef4bbd4938b5e74dc
Dependencies: Stopgaps:

Status badges

Description (last modified by mkoeppe)

  • #26964 now creates documentation files during bootstrap
  • make distclean blows away these generated files
  • subsequent make fails when building documentation

This ticket fixes it by deleting the generated files in bootstrap-clean instead of misc-clean.

Change History (14)

comment:1 Changed 2 years ago by vbraun

[dochtml] [installat] The HTML pages are in
[dochtml] Error building the documentation.
[dochtml] Traceback (most recent call last):
[dochtml]   File "/home/release/Sage/local/lib/python2.7/", line
174, in _run_module_as_main
[dochtml]     "__main__", fname, loader, pkg_name)
[dochtml]   File "/home/release/Sage/local/lib/python2.7/", line
72, in _run_code
[dochtml]     exec code in run_globals
[dochtml]   File "/home/release/Sage/local/lib/python2.7/site-
packages/sage_setup/docbuild/", line 2, in <module>
[dochtml]     main()
[dochtml]   File "/home/release/Sage/local/lib/python2.7/site-
packages/sage_setup/docbuild/", line 1720, in main
[dochtml]     builder()
[dochtml]   File "/home/release/Sage/local/lib/python2.7/site-
packages/sage_setup/docbuild/", line 336, in _wrapper
[dochtml]     build_many(build_other_doc, L)
[dochtml]   File "/home/release/Sage/local/lib/python2.7/site-
packages/sage_setup/docbuild/", line 280, in build_many
[dochtml]     _build_many(target, args, processes=NUM_THREADS)
[dochtml]   File "/home/release/Sage/local/lib/python2.7/site-
packages/sage_setup/docbuild/", line 283, in build_many
[dochtml]     raise worker_exc.original_exception
[dochtml] OSError:
/home/release/Sage/src/doc/en/installation/source.rst:228: WARNING:
Include file u'/home/release/Sage/src/doc/en/installation/debian.txt' not
found or reading it failed

comment:2 Changed 2 years ago by dimpase

make distclean should remove ./configure

comment:3 Changed 2 years ago by mkoeppe

Volker, are you sure you regenerated the configure tar ball?

comment:4 Changed 2 years ago by vbraun

Our distclean doesn't remove ./configure, neither should it ihmo. Distclean should remove whatever configure output there is, but it should keep the actual configure script which would go into a proper tarball.

comment:5 Changed 2 years ago by dimpase

well, then it's a bug that make distclean removes stuff not made by make all or by ./configure

comment:6 Changed 2 years ago by vbraun

Correct. And to fix it we can either kludge around with make distclean to not delete what should be build artifacts, or move building the documentation from bootstrap to make doc.

comment:7 Changed 2 years ago by dimpase

it's not just documentation. One possible way to use these is to generate help info before the build, something like: "you're on Debian, to make use of as many Debian external packages as possible do apt-get install ..."

comment:8 Changed 2 years ago by dimpase

also, it's used for CI. You need to tell your CI host what to install to minimise build time, and this is OS-specific and pre-build.

comment:9 Changed 2 years ago by mkoeppe

OK, deletion should be done by bootstrap-clean, not misc-clean. My bad.

However, note that bootstrap is the correct build phase for making these files. This build phase, after all, prepares src for sdist, the distribution for dist and for configure.

Last edited 2 years ago by mkoeppe (previous) (diff)

comment:10 Changed 2 years ago by mkoeppe

  • Branch set to u/mkoeppe/bootstrap____make_distclean_broken

comment:11 Changed 2 years ago by mkoeppe

  • Authors set to Matthias Koeppe
  • Commit set to 0dc97dbb12fcde2981cc0a4ef4bbd4938b5e74dc
  • Status changed from new to needs_review

New commits:

0dc97dbClean src/doc/en/installation/*.txt in bootstrap-clean, not misc-clean

comment:12 Changed 2 years ago by mkoeppe

  • Description modified (diff)

comment:13 Changed 2 years ago by dimpase

  • Reviewers set to Dima Pasechnik
  • Status changed from needs_review to positive_review


comment:14 Changed 2 years ago by vbraun

  • Branch changed from u/mkoeppe/bootstrap____make_distclean_broken to 0dc97dbb12fcde2981cc0a4ef4bbd4938b5e74dc
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.