fred/wallet
1
0
Fork 0
forked from cheng/wallet
Code Pull Requests Activity

documenting setup from clone

Browse Source
This commit is contained in:
aryan 2022-06-28 16:09:48 -07:00
parent 063c9f1f10
commit 3f38b6192b
No known key found for this signature in database
GPG Key ID: AAEB97E5E7AEDDB0
2 changed files with 44 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
docs/libraries.md
View File

@ -95,7 +95,7 @@ Libraries are best dealt with as [Git submodules].
[build libraries]:https://git-scm.com/book/en/v2/Git-Tools-Submodules [build libraries]:https://git-scm.com/book/en/v2/Git-Tools-Submodules
Git submodules leak complexity and surprising and inconvenient behavior Git submodules leak complexity and surprising and inconvenient behaviour
all over the place if one is trying to make a change that affects multiple all over the place if one is trying to make a change that affects multiple
modules simultaneously. But having your libraries separate from your git modules simultaneously. But having your libraries separate from your git
repository results in non portable surprises and complexity. Makes it hard repository results in non portable surprises and complexity. Makes it hard
@ -134,19 +134,29 @@ tag, not by branch, and the names of branches are only used to
communicate a particular project on the submodule to other people communicate a particular project on the submodule to other people
working on that project as their master project. working on that project as their master project.
Branch names are not useful within a submodule, though Branch names within a submodule, though very useful when you working
submodule may well be, from the point of view of the primary on a submodule, are not useful to the project as a whole, and except for the
developers, not a submodule but a module in its own right, used as primary fork name, should be temporary and local., not pushed to the
a submodule in many different modules, so for them, branch names project repository, But when you are modifying the submodules in a
will be useful. But when you are modifying the submodules in a project as a single project, making related changes in the module and
project as a single project, making related changes in the module submodule, the shared names that are common to all developers belong in
and submodule, the names belong in the primary project module, the primary project module,and when you have done with a submodule,
Within the submodule, commits are nameless with detached head,
the name in primary module naming a group of related commits in ```bash
several submodules, which commits do not usually receive git switch --detach
independent names of their own, even though the commits have to ```
be made within the submodule, not in the containing module which
names the complete set of interrelated commits. Within the submodule, commits are nameless with detached head, except
when you are working on them, the name in primary module naming a
group of related commits in several submodules, which commits do not
usually receive independent names of their own, even though the commits
have to be made within the submodule, not in the containing module
which names the complete set of interrelated commits.
The submodule commits may well belong to different branches and tags in
the superproject, but in the submodules, they are nameless in that all the
submodule commits wind up attached to the same branch, your submodule tracking
branch.
In this case, working on submodules as part of a single larger project, you should set In this case, working on submodules as part of a single larger project, you should set
@ -182,19 +192,24 @@ Make sure things still work. Get everything working. (You do have unit test, r
then: then:
```bash ```bash
git submodule foreach --recursive 'git push origin HEAD:«your-tracking-branch»'
git submodule foreach --recursive 'git switch --detach' git submodule foreach --recursive 'git switch --detach'
git submodule foreach --recursive 'git push origin HEAD:«your-tracking-branch»'
``` ```
You pull a named release of the project that is a submodule of your project
from `upstream`, diddling with it to make it work with your project, then
you push it to `origin` as a nameless commit, though you probably gave the
various commits you made while working on it temporary and local names
with `switch -c yet-another-idea`
All of which, of course, presupposes you have already set unit tests, All of which, of course, presupposes you have already set unit tests,
upstream, origin, and your tracking branch appropriately. upstream, origin, and your tracking branch appropriately.
Even if your local modifications are nameless in your local Even if your local modifications are nameless in your local submodule
submodule repository, on your remote submodule repository they repository, on your remote submodule repository they need to have a name
need to have a name to be pushed to, hence you need to have a to be pushed to, hence you need to have a tracking branch in each of your
tracking branch in each of your remote images of each of your remote images of each of your submodules, and that tracking branch will
submodules, and that tracking branch will need to point to the root need to point to the root of a tree of all the nameless commits that the
of a tree of all the nameless commits that the names and commits names and commits
in your superproject that contains this submodules point to. in your superproject that contains this submodules point to.
You want `.gitmodules` in your local image of the repository to You want `.gitmodules` in your local image of the repository to
@ -241,7 +256,7 @@ means you can incorporate unlimited amounts of stuff, and Git only has to
check the particular module that you are actually working on. check the particular module that you are actually working on.
Maybe subtrees would work better if one was working on a project where Maybe subtrees would work better if one was working on a project where
several parts were being developed at once, thus a project small enough several parts wer e being developed at once, thus a project small enough
that scaling is not an issue. But such projects, if successful, grow into that scaling is not an issue. But such projects, if successful, grow into
projects where scaling is an issue. And if you are a pure consumer of a projects where scaling is an issue. And if you are a pure consumer of a
library, you don't care that you are breaking the git model, because you are library, you don't care that you are breaking the git model, because you are

7
docs/rootDocs/README.md
View File

@ -120,6 +120,13 @@ unless you tell `gpg` to trust the key that is in the root directory as
Never check any Gpg key related to this project against a public Never check any Gpg key related to this project against a public
gpg key repository. It should not be there. gpg key repository. It should not be there.
`gitconfig` disallows merges unless you have told `gpg` to trust the public
key corresponding to the private key that signed the tip of the root. So part
of the pull request process is getting the puller to trust your public key, and
you will not be able to pull updates unless you tell `gpg` to trust the key that
is in the root directory as `public_key.gpg`.
Never use any email address on a gpg key related to this project Never use any email address on a gpg key related to this project
unless it is only used for project purposes, or a fake email, or the unless it is only used for project purposes, or a fake email, or the
email of an enemy. We don't want Gpg used to link different email email of an enemy. We don't want Gpg used to link different email