[RFC/PoC,0/5] Provide example docbundles

Message

Philip Oakley Nov. 2, 2022, 10:48 p.m. UTC

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