diff mbox series

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

Message ID 20221102224843.2104-3-philipoakley@iee.email (mailing list archive)
State New, archived
Headers show
Series Provide example docbundles | expand

Commit Message

Philip Oakley Nov. 2, 2022, 10:48 p.m. UTC
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.

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.
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(+)

Comments

Ævar Arnfjörð Bjarmason Nov. 3, 2022, 9:12 a.m. UTC | #1
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.
Philip Oakley Nov. 3, 2022, 7:50 p.m. UTC | #2
On 03/11/2022 09:12, Ævar Arnfjörð Bjarmason wrote:
> 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.
>
>> 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
>
>> 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
diff mbox series

Patch

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