git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Philip Oakley <philipoakley@iee.email>
Cc: GitList <git@vger.kernel.org>, Junio C Hamano <gitster@pobox.com>,
	Taylor Blau <me@ttaylorr.com>
Subject: Re: [RFC/PoC 2/5] Documentation Bundles: ignore artifact files from creating doc bundles
Date: Thu, 03 Nov 2022 10:12:17 +0100	[thread overview]
Message-ID: <221103.86zgd81jtm.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <20221102224843.2104-3-philipoakley@iee.email>


On Wed, Nov 02 2022, Philip Oakley wrote:

> The Git documentation contains many examples that can be prepared as
> repository bundles for users to clone and explore without any language
> or translation confusions between the written word and intended code.

I just find this commit entirely confusing, we're adding .gitignore
entries, but nothing generates these yet (but I'll read on). All to
describe some seeming future feature...

> There are also a large number of example repositories in the t/ test
> system can can also be exposed to users to highlight the critical
> distinctions tested therein.
>
> These documentation bundles will be prepared ar part of the test system.

s/ar/as/

> Start by ignoring those parts which will be considered build artifacts,
> the GIT-BUNDLE-DIR, and the `.bndl` bundle files themselves.
>
> The artifacts themselves will later be manipulated by the `make` elements
> of the documentation system.
>
> Signed-off-by: Philip Oakley <philipoakley@iee.email>
> ---
>  .gitignore | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/.gitignore b/.gitignore
> index 6ded10067a..b96a4ce5df 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -3,6 +3,7 @@
>  /fuzz-pack-headers
>  /fuzz-pack-idx
>  /GIT-BUILD-OPTIONS
> +/GIT-BUNDLE-DIR
>  /GIT-CFLAGS
>  /GIT-LDFLAGS
>  /GIT-PREFIX
> @@ -250,3 +251,4 @@ Release/
>  *.dSYM
>  /contrib/buildsystems/out
>  CMakeSettings.json
> +*.bndl

We've been putting quite a few things in .build/ recently, so whatever
this is, if you put it in .build/test-bundles/ or whatever you don't
need to write "clean" rules for it, or add this ignore entry.

  reply	other threads:[~2022-11-03  9:17 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-02 22:48 [RFC/PoC 0/5] Provide example docbundles Philip Oakley
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 [this message]
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=221103.86zgd81jtm.gmgdl@evledraar.gmail.com \
    --to=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=me@ttaylorr.com \
    --cc=philipoakley@iee.email \
    /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).