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

Re: [RFC/PoC 2/5] Documentation Bundles: ignore artifact files from creating doc bundles

From
Philip Oakley <philipoakley@iee.email>
Date
Nov 3, 2022, 19:50 UTC
Message-ID
<7baed8ab-075f-52d4-52d2-3e555ea59c5d@iee.email>
In-Reply-To
<221103.86zgd81jtm.gmgdl@evledraar.gmail.com>
On 03/11/2022 09:12, Ævar Arnfjörð Bjarmason wrote:
Show 8 quoted lines
> 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...

Probably could be squashed in with the others once the PoC has matured a bit.

Show 7 quoted lines
>
>> 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/
Ok
Show 32 quoted lines
>
>> 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.
Ok. I'd also hadn't considered the 'clean' rules for the make file.
Philip
Previous: Ævar Arnfjörð BjarmasonNext: Philip Oakley
Message 4 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.