git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[RFC/PoC 0/5] Provide example docbundles

From
Philip Oakley <philipoakley@iee.email>
Date
Nov 2, 2022, 22:48 UTC
Message-ID
<20221102224843.2104-1-philipoakley@iee.email>

The man pages provide user facing examples which explain important concepts, such as history-simplification. However users can have difficulty in reproducing these examples to allow the exploration of thr concepts. Let's provide these simple example, pre-packaged as part of the documentation.

This Request for Comment (RFC) / Proof of Concept (PoC) attempts to set out some design aims, and an outline implementation based on using bundles for each example, and the test system for their preparation.

Are there any obvious show-stoppers? Where best to hold the docbundle dir on various platforms? How many examples to provide, and how to decide? Usage of existing test repo examples? etc. -- Philip

Philip Oakley (5):
  doc: provide DocBundles design document
  Documentation Bundles: ignore artifact files from creating doc bundles
  test-lib: add GIT_BUNDLE_DIR setup
  Doc Bundles: add t6102 rev-list simple and pulls examples
  docbundle: provide the git-log History Simplication example
 .gitignore                            |   2 +
 Documentation/technical/docbundle.txt |  97 ++++++++++
 t/t6012-rev-list-simplify.sh          |   8 +
 t/t9990-history-simplification.sh     | 261 ++++++++++++++++++++++++++
 t/test-lib.sh                         |  14 ++
 5 files changed, 382 insertions(+)
 create mode 100644 Documentation/technical/docbundle.txt
 create mode 100644 t/t9990-history-simplification.sh
-- 
2.38.1.281.g83ef3ded8d
Next: Philip Oakley
Message 1 of 15 in “[RFC/PoC 0/5] Provide example docbundles”
  1. Philip OakleyNov 2, 2022
  2. 2/5 Documentation Bundles: ignore artifact files from creating doc bundlesPhilip Oakley, Nov 2, 2022
  3. Ævar Arnfjörð BjarmasonNov 3, 2022
  4. Philip OakleyNov 3, 2022
  5. 1/5 doc: provide DocBundles design documentPhilip Oakley, Nov 2, 2022
  6. Ævar Arnfjörð BjarmasonNov 3, 2022
  7. Philip OakleyNov 3, 2022
  8. Ævar Arnfjörð BjarmasonNov 3, 2022
  9. 3/5 test-lib: add GIT_BUNDLE_DIR setupPhilip Oakley, Nov 2, 2022
  10. Ævar Arnfjörð BjarmasonNov 3, 2022
  11. Philip OakleyNov 3, 2022
  12. 4/5 Doc Bundles: add t6102 rev-list simple and pulls examplesPhilip Oakley, Nov 2, 2022
  13. 5/5 docbundle: provide the git-log History Simplification examplePhilip Oakley, Nov 2, 2022
  14. Ævar Arnfjörð BjarmasonNov 3, 2022
  15. Philip OakleyNov 3, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.