Opened 3 years ago
Closed 3 years ago
#21565 closed enhancement (fixed)
Add src/README.txt and build/README.txt
Reported by: | mkoeppe | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | sage-7.4 |
Component: | build | Keywords: | |
Cc: | vbraun, jdemeyer, embray, fbissey, dimpase, chapoton | Merged in: | |
Authors: | Matthias Koeppe | Reviewers: | Dima Pasechnik |
Report Upstream: | N/A | Work issues: | |
Branch: | 1b45e56 (Commits) | Commit: | 1b45e560c8571db9423c51cd2c9420fa7f396867 |
Dependencies: | Stopgaps: |
Description (last modified by )
This ticket adds README files that explain the purpose of the src
and build
directories.
Also, src/setup.py sdist (#21516) is asking for a README, so we make it happy too.
Change History (8)
comment:1 Changed 3 years ago by
- Branch set to u/mkoeppe/add_src_readme_txt_and_build_readme_txt
comment:2 Changed 3 years ago by
- Cc vbraun jdemeyer embray fbissey added
- Commit set to 39f5eb9f6388366e07cb1352bec33856f15fe979
- Description modified (diff)
- Status changed from new to needs_review
comment:3 Changed 3 years ago by
- Commit changed from 39f5eb9f6388366e07cb1352bec33856f15fe979 to 1b45e560c8571db9423c51cd2c9420fa7f396867
Branch pushed to git repo; I updated commit sha1. New commits:
1b45e56 | Fix typo in README
|
comment:4 Changed 3 years ago by
- Cc dimpase chapoton added
comment:5 follow-up: ↓ 6 Changed 3 years ago by
- Reviewers set to Dima Pasechnik
looks good enough to me (I'm a bit unhappy about .txt suffix vs no such suffix in other READMEs, but OK).
comment:6 in reply to: ↑ 5 Changed 3 years ago by
Replying to dimpase:
looks good enough to me
Is this a "positive review"?
I'm a bit unhappy about .txt suffix vs no such suffix in other READMEs, but OK
Note the majority of our README files already has .txt
as a suffix.
$ find build -name README\* build/pkgs/atlas/patches/ATLAS-lib/README build/pkgs/bzip2/patches/autotools/README.autotools build/pkgs/giac/patches/README.txt build/pkgs/pari/patches/README.txt build/sage_bootstrap/README $ find src -name README\* src/mac-app/tools/createDSStore/README.txt src/sage/ext/mac-app/README src/sage/libs/gap/test/README.txt src/sage/rings/bernmm/README.txt src/sage/rings/bernmm/README2.txt src/sage/rings/padics/README.txt src/sage/schemes/hyperelliptic_curves/hypellfrob/README src/sage/tests/french_book/README
comment:7 Changed 3 years ago by
- Status changed from needs_review to positive_review
OK - was in hurry and did not notice that I didn't set it to positive review, sorry.
comment:8 Changed 3 years ago by
- Branch changed from u/mkoeppe/add_src_readme_txt_and_build_readme_txt to 1b45e560c8571db9423c51cd2c9420fa7f396867
- Resolution set to fixed
- Status changed from positive_review to closed
Needs review. New commits that improve/expand these descriptions are, of course, welcome too.
New commits:
Add READMEs