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

README.md: Move all mentions of release tarballs to the installation guide #37309

Merged
merged 6 commits into from
Mar 25, 2024

Conversation

mkoeppe
Copy link
Contributor

@mkoeppe mkoeppe commented Feb 13, 2024

As proposed in https://groups.google.com/g/sage-devel/c/5kmxaw105lg/m/liCPKG4bAQAJ

The README.md now starts with instructions to install git and then use git clone.

📝 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

Copy link
Member

@jhpalmieri jhpalmieri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, just a few minor comments. I'm happy to approve, although I'm not sure if this should be merged yet, since the "discussion" on sage-devel is ongoing.

src/doc/en/installation/source.rst Outdated Show resolved Hide resolved
src/doc/en/installation/source.rst Outdated Show resolved Hide resolved
src/doc/en/installation/source.rst Outdated Show resolved Hide resolved
src/doc/en/installation/source.rst Outdated Show resolved Hide resolved
@mkoeppe
Copy link
Contributor Author

mkoeppe commented Feb 20, 2024

I'm not sure if this should be merged yet, since the "discussion" on sage-devel is ongoing.

I'd say, let's just go ahead. Haven't seen any reaction in the thread (other than yours)

@mkoeppe mkoeppe self-assigned this Feb 21, 2024
@saraedum
Copy link
Member

Cloning the repo uses 1GB of disk (without any upstream packages downloaded.) Using the tarball seems more economical to me in this case. Downloading a tarball of the GitHub repo (which is not advertised anywhere) is just 28MB for me.

Anyway, I don't really mind much either way. If you guys think this is a good idea, go ahead.

@dimpase
Copy link
Member

dimpase commented Feb 21, 2024

Cloning the repo uses 1GB of disk (without any upstream packages downloaded.)

no, it's "only" 615 Mb, and over 60% of it is .git/

$ git clone -c core.symlinks=true --origin upstream --branch develop --tags https://github.com/sagemath/sage.git
...
$ du -h sage/
...
615M	sage/
$ du -h sage/.git
388M	sage/.git/objects/pack
...
390M	sage/.git

Adding --filter=blob:none, as recommended in https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/ - results in only 141Mb in sage/.git, and 366M for the whole sage/.

Perhaps this is, disk space and bandwidth-wise, a better advice than the one in the PR, to use the latter.

Using the tarball seems more economical to me in this case. Downloading a tarball of the GitHub repo (which is not advertised anywhere) is just 28MB for me.

Anyway, I don't really mind much either way. If you guys think this is a good idea, go ahead.

Copy link
Member

@dimpase dimpase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consider adding --filter=blob:none to git clone options

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Feb 21, 2024

Done in 04145de

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Feb 21, 2024

Also need to link to git install instructions (similar to #30201)

Edit: Done in 8a1a459

Copy link

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

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Feb 26, 2024

Thanks for the review.

@mkoeppe mkoeppe removed this from the sage-10.3 milestone Mar 20, 2024
@vbraun vbraun merged commit 6fa97ea into sagemath:develop Mar 25, 2024
14 of 15 checks passed
@mkoeppe mkoeppe added this to the sage-10.4 milestone Mar 25, 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.

Developer's Guide: Update git installation instructions
5 participants