diff options
author | Thien-Thi Nguyen <ttn@gnuvola.org> | 2021-12-23 21:15:18 -0500 |
---|---|---|
committer | Thien-Thi Nguyen <ttn@gnuvola.org> | 2021-12-23 21:15:33 -0500 |
commit | 75521ca67fe9ad7f18de8e02504f1d656c8dc1a3 (patch) | |
tree | 9eda36d16061debf829506fc7b42ca8415136042 /README | |
parent | 117b11a28b00588cb3a982323161bb61a15f8c9c (diff) | |
download | docs-75521ca67fe9ad7f18de8e02504f1d656c8dc1a3.tar.gz docs-75521ca67fe9ad7f18de8e02504f1d656c8dc1a3.tar.bz2 docs-75521ca67fe9ad7f18de8e02504f1d656c8dc1a3.zip |
add instructions on managing branch ‘prebuilt’ to top-level README
(These instructions are what works for me; people should
feel free to augment them w/ their own preferred workflows.)
Diffstat (limited to 'README')
-rw-r--r-- | README | 18 |
1 files changed, 17 insertions, 1 deletions
@@ -14,4 +14,20 @@ Then, do "make html" for HTML, "make texinfo" for Texinfo, etc. The output is in subdir ‘_build’. -TODO: Add instructions on how to build/export/integrate ‘prebuilt’ docs. +Branch ‘prebuilt’ is special. Its contents (or a subset) are used as +submodules in other Git repos (e.g., Exchange, Merchant, Sync). + +One approach that works well (so far) for ttn is to do +(presuming that the current directory is named ‘docs’): + + $ cd .. + $ git clone -b prebuilt --reference docs \ + git+ssh://git@git.taler.net/docs.git \ + docs-prebuilt + +This creates Git repo docs-prebuilt as a peer to the current repo. + +This way, you can build in this directory (i.e., "make man" or whatever) +and then copy to ../docs-prebuilt/man/* what files need to be updated. +In that repo, you can commit changes and push to git.taler.net as normal, +all without having to do "git checkout" in either repo. |