From: Philip Oakley <philipoakley@iee.email>
To: GitList <git@vger.kernel.org>
Cc: Self <philipoakley@iee.email>, Junio C Hamano <gitster@pobox.com>,
Taylor Blau <me@ttaylorr.com>
Subject: [RFC/PoC 0/5] Provide example docbundles
Date: Wed, 2 Nov 2022 22:48:38 +0000 [thread overview]
Message-ID: <20221102224843.2104-1-philipoakley@iee.email> (raw)
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 reply other threads:[~2022-11-02 22:49 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-02 22:48 Philip Oakley [this message]
2022-11-02 22:48 ` [RFC/PoC 1/5] doc: provide DocBundles design document Philip Oakley
2022-11-03 9:19 ` Ævar Arnfjörð Bjarmason
2022-11-03 19:50 ` Philip Oakley
2022-11-03 20:36 ` Ævar Arnfjörð Bjarmason
2022-11-02 22:48 ` [RFC/PoC 2/5] Documentation Bundles: ignore artifact files from creating doc bundles Philip Oakley
2022-11-03 9:12 ` Ævar Arnfjörð Bjarmason
2022-11-03 19:50 ` Philip Oakley
2022-11-02 22:48 ` [RFC/PoC 3/5] test-lib: add GIT_BUNDLE_DIR setup Philip Oakley
2022-11-03 9:14 ` Ævar Arnfjörð Bjarmason
2022-11-03 19:50 ` Philip Oakley
2022-11-02 22:48 ` [RFC/PoC 4/5] Doc Bundles: add t6102 rev-list simple and pulls examples Philip Oakley
2022-11-02 22:48 ` [RFC/PoC 5/5] docbundle: provide the git-log History Simplification example Philip Oakley
2022-11-03 9:17 ` Ævar Arnfjörð Bjarmason
2022-11-03 19:50 ` Philip Oakley
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221102224843.2104-1-philipoakley@iee.email \
--to=philipoakley@iee.email \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).