Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various edits of developer guide #37206

Merged
merged 2 commits into from
Feb 25, 2024

Conversation

kwankyu
Copy link
Collaborator

@kwankyu kwankyu commented Jan 31, 2024

Mostly small edits and

  • updated sections on testing facilities
  • added how to go back exited container.
  • moved the section "Testing GitHub Actions locally" to an appropriate place.

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@kwankyu kwankyu changed the title Minor various edits Minor various edits of developer guide Jan 31, 2024
@kwankyu
Copy link
Collaborator Author

kwankyu commented Jan 31, 2024

@mkoeppe

I created this PR draft since I experienced a certain failure in following "Testing on Multiple Platforms" of the developer guide, while testing #36915 . Precisely I followed the guide in the section "Testing on multiple platforms using Docker", and created a docker container with "fedora:latest" image:

docker run -it --mount type=bind,source=$(pwd),target=/sage fedora:latest

but during "make -j4", I got lots of errors like

...
[python3-3.11.1] cp: preserving permissions for '/sage/local/var/lib/sage/venv-python3.11.1/./include/python3.11/weakrefobject.h': No data available
[python3-3.11.1] cp: preserving permissions for '/sage/local/var/lib/sage/venv-python3.11.1/./include/python3.11/pyconfig.h': No data available
[python3-3.11.1] cp: preserving permissions for '/sage/local/var/lib/sage/venv-python3.11.1/./share/man/man1/python3.11.1': No data available
[python3-3.11.1] ************************************************************************
[python3-3.11.1] Error moving files for python3-3.11.1.
[python3-3.11.1] ************************************************************************
[python3-3.11.1] Please email sage-devel (http://groups.google.com/group/sage-devel)
[python3-3.11.1] explaining the problem and including the log files
[python3-3.11.1]   /sage/logs/pkgs/python3-3.11.1.log
[python3-3.11.1] and
[python3-3.11.1]   /sage/config.log
[python3-3.11.1] Describe your computer, operating system, etc.
[python3-3.11.1] ************************************************************************
make[4]: *** [Makefile:3387: python3-SAGE_VENV-no-deps] Error 1
make[3]: *** [Makefile:3387: /sage/local/var/lib/sage/venv-python3.11.1/var/lib/sage/installed/python3-3.11.1] Error 2
make[2]: *** [Makefile:3017: all-start] Error 2
make[2]: Leaving directory '/sage/build/make'

real	5m43.508s
user	12m47.083s
sys	3m4.712s
***************************************************************
Error building Sage.

The following package(s) may have failed to build (not necessarily
during this run of 'make all-start'):

* package:         gap-4.12.2
  last build time: Jan 30 06:42
  log file:        /sage/logs/pkgs/gap-4.12.2.log
  build directory: /sage/local/var/tmp/sage/build/gap-4.12.2

* package:         ecm-7.0.5
  last build time: Jan 31 05:58
  log file:        /sage/logs/pkgs/ecm-7.0.5.log
  build directory: /sage/local/var/tmp/sage/build/ecm-7.0.5

* package:         givaro-4.1.1
  last build time: Jan 31 05:58
  log file:        /sage/logs/pkgs/givaro-4.1.1.log
  build directory: /sage/local/var/tmp/sage/build/givaro-4.1.1

* package:         eclib-20231212
  last build time: Jan 31 06:00
  log file:        /sage/logs/pkgs/eclib-20231212.log
  build directory: /sage/local/var/tmp/sage/build/eclib-20231212

* package:         python3-3.11.1
  last build time: Jan 31 06:02
  log file:        /sage/logs/pkgs/python3-3.11.1.log

It is safe to delete any log files and build directories, but they
contain information that is helpful for debugging build problems.
WARNING: If you now run 'make' again, the build directory of the
same version of the package will, by default, be deleted. Set the
environment variable SAGE_KEEP_BUILT_SPKGS=yes to prevent this.

make[1]: *** [Makefile:40: all-start] Error 1
make[1]: Leaving directory '/sage'
make: *** [Makefile:13: all] Error 2

Hence I suspect that there is something wrong in the guide. By the way, there is no problem in building sage in a container with no --mount type=bind,source=$(pwd),target=/sage (of course, in this case, I created /sage directory as a sage git repository).

Do you know what is wrong (where to edit) in the guide?

I am using Docker Desktop 4.26.1 on mac.

@mkoeppe
Copy link
Contributor

mkoeppe commented Jan 31, 2024

As far as I can see, the command is correct as is; compare with https://docs.docker.com/storage/bind-mounts/#start-a-container-with-a-bind-mount

Try if you see the same problem with a different Docker image.
(I can't try it right now.)

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jan 31, 2024

Right. There's no problem with ubuntu and archlinux images. Thus it seems a fedora problem...

@kwankyu
Copy link
Collaborator Author

kwankyu commented Jan 31, 2024

Another question: are we still running sage buildbots? If no, the section on "sage buildbots" could be removed.

@mkoeppe
Copy link
Contributor

mkoeppe commented Jan 31, 2024

Another question: are we still running sage buildbots?

"We" are, as in, Volker runs them as part of what he's doing.

@kwankyu kwankyu force-pushed the p/edit-developer-guide branch from 7851fc2 to 5e57e42 Compare February 18, 2024 22:57
@kwankyu kwankyu marked this pull request as ready for review February 18, 2024 23:00
@kwankyu kwankyu force-pushed the p/edit-developer-guide branch from 5e57e42 to dec1d09 Compare February 19, 2024 02:30
@kwankyu kwankyu changed the title Minor various edits of developer guide Various edits of developer guide Feb 19, 2024
Co-authored-by: Matthias Köppe <mkoeppe@math.ucdavis.edu>
Copy link

Documentation preview for this PR (built with commit 311911e; changes) is ready! 🎉

@vbraun vbraun merged commit abc7099 into sagemath:develop Feb 25, 2024
18 checks passed
@mkoeppe mkoeppe added this to the sage-10.3 milestone Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants