Opened 6 years ago
Closed 6 years ago
#17555 closed defect (fixed)
Remove the dev scripts' documentation
Reported by: | ncohen | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | sage-6.5 |
Component: | documentation | Keywords: | |
Cc: | dimpase, vbraun, fbissey, mmarco, jpflori, rws, SimonKing | Merged in: | |
Authors: | Nathann Cohen | Reviewers: | François Bissey |
Report Upstream: | N/A | Work issues: | |
Branch: | 5c37a78 (Commits) | Commit: | 5c37a78c3b5b1491bf4de7a5ca447364c076f09c |
Dependencies: | Stopgaps: |
Description
On a sage-devel thread [1] there seems to be a general agreement that the dev scripts should be kept around for those who use them, but that we should remove the doc so that new users learn 'git trac' or git directly.
The doc has been printing a hint to "not use them" since a while, by the way.
Nathann
[1] https://groups.google.com/d/topic/sage-devel/JtVWAdvw-3A/discussion
Change History (16)
comment:1 Changed 6 years ago by
- Branch set to public/17555
- Status changed from new to needs_review
comment:2 Changed 6 years ago by
- Commit set to 49ab0bfde612e284685535e1d9387b2a1849559e
comment:3 Changed 6 years ago by
Should you not remove more stuff from src/doc/en/reference/dev/index.rst? It looks to me like the whole of the sage/dev hierarchy is made up of sage-dev scripts and commands.
comment:4 Changed 6 years ago by
- Commit changed from 49ab0bfde612e284685535e1d9387b2a1849559e to 40220f712f59ca51491ad1a427f2db34e839e83b
Branch pushed to git repo; I updated commit sha1. New commits:
40220f7 | trac #17555: Some other references to the doc
|
comment:5 Changed 6 years ago by
Done !
Nathann
comment:6 Changed 6 years ago by
- Reviewers set to François Bissey
- Status changed from needs_review to positive_review
Looks good to me.
comment:7 Changed 6 years ago by
Thanks !
Nathann
comment:8 Changed 6 years ago by
- Status changed from positive_review to needs_work
Conflicts with #17534
comment:9 Changed 6 years ago by
- Commit changed from 40220f712f59ca51491ad1a427f2db34e839e83b to fdc52e9d62ea0002dc7d6d32bddcf827555d5503
Branch pushed to git repo; I updated commit sha1. New commits:
4ae1934 | trac #17534: The reviewer's checklist
|
a4615b0 | trac #17534: Reviewers' comments
|
375d087 | trac #17534: Reviewer's comments
|
4ff64c1 | trac #17534: Reviewer's comments
|
79bbb56 | Final English and other fixes
|
fdc52e9 | trac #17555: Merged with #17534
|
comment:10 Changed 6 years ago by
- Status changed from needs_work to positive_review
comment:11 Changed 6 years ago by
- Status changed from positive_review to needs_work
Documentation doesn't build
[developer] /scratch/buildbot/sage/redhawk-1/sage_git/build/src/doc/en/developer/git_trac.rst:16: WARNING: undefined label: chapter-devscript (if the link has no caption the label must precede a section header) Error building the documentation. Traceback (most recent call last): File "/scratch/buildbot/sage/redhawk-1/sage_git/build/src/doc/common/builder.py", line 1618, in <module> getattr(get_builder(name), type)() File "/scratch/buildbot/sage/redhawk-1/sage_git/build/src/doc/common/builder.py", line 306, in _wrapper x.get(99999) File "/scratch/buildbot/sage/redhawk-1/sage_git/build/local/lib/python/multiprocessing/pool.py", line 558, in get raise self._value OSError: [developer] /scratch/buildbot/sage/redhawk-1/sage_git/build/src/doc/en/developer/git_trac.rst:16: WARNING: undefined label: chapter-devscript (if the link has no caption the label must precede a section header)
comment:12 Changed 6 years ago by
- Commit changed from fdc52e9d62ea0002dc7d6d32bddcf827555d5503 to 5c37a78c3b5b1491bf4de7a5ca447364c076f09c
Branch pushed to git repo; I updated commit sha1. New commits:
5c37a78 | trac #17555: remove mention of the dev scripts
|
comment:13 Changed 6 years ago by
Sorry for that, I should have seen it :-/
There was a mention left of this "sagedev" scripts. I added a commit to removes it: could anybody review it ? It is quite short.
Thanks,
Nathann
comment:14 Changed 6 years ago by
- Status changed from needs_work to needs_review
comment:15 Changed 6 years ago by
- Status changed from needs_review to positive_review
Yes indeed. In sage-on-gentoo I remove that folder altogether which is why I didn't realise you had missed one bit.
comment:16 Changed 6 years ago by
- Branch changed from public/17555 to 5c37a78c3b5b1491bf4de7a5ca447364c076f09c
- Resolution set to fixed
- Status changed from positive_review to closed
Branch pushed to git repo; I updated commit sha1. New commits:
trac #17555: Remove the dev scripts' documentation