Skip to content

Commit eb80cc0

Browse files
author
Release Manager
committed
gh-39962: Docs: Migrate developer walkthrough to Meson <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes #12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes #12345". --> Migrates the developer walkthrough to use meson (on top of conda) for the easist and most modern setup. Also streamlined the instructions a bit. Moreover, the main installation page now simply refers to the developer walkthrough for the dev setup. Finally, a few outdated info about binaries and linux distro is removed. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] 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 and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> URL: #39962 Reported by: Tobias Diez Reviewer(s): Dima Pasechnik, user202729
2 parents b800a70 + 5f6adad commit eb80cc0

File tree

7 files changed

+186
-361
lines changed

7 files changed

+186
-361
lines changed

src/doc/en/developer/git_basic.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,7 @@ Sometimes, a new version of Sage is released while you work on a Git branch.
206206

207207
Let us assume you started ``my_branch`` at commit ``B``. After a while, your
208208
branch has advanced to commit ``Z``, but you updated ``develop`` (see
209-
:ref:`section-git-pull-develop`) and now your Git history looks like this (see
210-
:ref:`section_walkthrough_logs`):
209+
:ref:`section-git-pull-develop`) and now your Git history looks like this:
211210

212211
.. CODE-BLOCK:: text
213212

src/doc/en/developer/review.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,16 @@ Anybody (e.g. you) can do this job for somebody else's PR. This document
1717
lists things that the reviewer must check before deciding that a PR is
1818
ready for inclusion into Sage.
1919

20-
You can now begin the review by reading the diff code.
21-
2220
**Check the GitHub checks:** We require all checks have passed.
2321

2422
**Read the diff:** Click "Files changed" tab of the PR. Read through the
2523
changes of all modified files. We use `pull request reviews
2624
<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews>`_.
2725
You can add comments directly to changed lines.
2826

29-
**Build the code:** (This is optional if the **build and test** check has passed.)
30-
While you read the code, you can :ref:`rebuild Sage with the new code
31-
<section-walkthrough-make>`. If you do not know how to **download the code**,
32-
:ref:`see here <section-workflows-pr-checkout>`.
27+
**Test the code:** (This is optional if the **build and test** check has passed.)
28+
Checkout the **code of the PR** following :ref:`see here <section-workflows-pr-checkout>`
29+
and run the relevant tests.
3330

3431
The following should generally be checked while reading and testing the code:
3532

0 commit comments

Comments
 (0)