README: document package localisation #4377
Conversation
deepfire
force-pushed
the
document-package-localisation
branch
8 times, most recently
from
d995f59
to
dff6fe7
Compare
deepfire
force-pushed
the
document-package-localisation
branch
7 times, most recently
from
d3aaa3a
to
c737bcf
Compare
deepfire
force-pushed
the
document-package-localisation
branch
11 times, most recently
from
9d08d83
to
87becaf
Compare
deepfire
force-pushed
the
document-package-localisation
branch
7 times, most recently
from
2614759
to
bc39a1b
Compare
deepfire
force-pushed
the
document-package-localisation
branch
2 times, most recently
from
85d8d49
to
6fcd6dd
Compare
|
I'm interested to know if the new instructions will work on a Mac (Intel or M1). I think this should be documented to let people know whether the instructions are worth trying on these platforms. |
|
bors r+ |
4377: README: document package localisation r=deepfire a=deepfire In the README: 1. Add a ToC. 2. Fix the structure, so the ToC actually makes sense. 3. Fix some minor RST syntax issues. 4. Some very minor fixes. 5. Expand the Development section with the workbench usage info. 6. Add `cabal-plan` and `graphmod` to the workbench shell. Co-authored-by: Kosyrev Serge <[email protected]>
|
This PR was included in a batch that successfully built, but then failed to merge into master. It will not be retried. Additional information: {"message":"Waiting on code owner review from fmaste and/or mgmeier.","documentation_url":"https://docs.github.com/articles/about-protected-branches"} |
README.rst
Outdated
| Normally, to work on ``cardano-node`` dependencies in the context of the node itself, one needs to go through an expensive multi-step process, mandated by the Nix model: | ||
| - Make changes to a dependency (say ``ouroboros-consensus-cardano`` in the ``ouroboros-network`` repository), commit them & push to Github. | ||
| - Calculate & bump the pin for that dependency in ``cardano-node``, inside its ``cabal.project``. | ||
| - Re-enter the Nix shell in ``cardano-node``, suffering full rebuilds of everything. |
There was a problem hiding this comment.
What's the point of describing this workflow if the actual thing you want to document is below? Also, the language used here is sarcastic and makes the reader question why we are using nix if it is resulting in "suffering full rebuilds of everything".
I would suggest to frame the whole section of "Dependency localisation" in a more positive way.
There was a problem hiding this comment.
Also, the language used here is sarcastic and makes the reader question why we are using nix if it is resulting in "suffering full rebuilds of everything".
Was not intended to be sarcastic at all -- just recognising a difficult reality we all had to deal with (and that's for a reason, also).
But perhaps you are right -- I should find a more neutral wording.
deepfire
force-pushed
the
document-package-localisation
branch
from
6fcd6dd
to
9b5fe60
Compare
I've tested both |
deepfire
force-pushed
the
document-package-localisation
branch
from
8e9e035
to
f75b4b3
Compare
|
bors r+ |
|
Build succeeded: |
In the README:
cabal-planandgraphmodto the workbench shell.