[PATCH] gitignore: ignore documentation build products

[PATCH] gitignore: ignore documentation build products

[Sascha Silbe]

There are several different manuals by now, all of which produce
output. The "eclipse" directory might even have been present the last
time .gitignore was updated.

Ignore all files and directories generated during "make
DOC=<directory>" for all existing manuals as well as "make
DOC=<directory> pdf" for all manuals that support PDF
generation. While at it, make sure the patterns only match for the
top-level documentation directory.

Signed-off-by: Sascha Silbe <x-yo17@se-silbe.de>
---

Resent because the previous one disappeared into nirvana (mailing list
silently dropping mails from non-subscribers?).

 .gitignore | 31 ++++++++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index 94894d498c..f1da5b2df9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,9 +18,34 @@ hob-image-*.bb
 !meta-yocto
 !meta-yocto-bsp
 !meta-yocto-imported
-documentation/user-manual/user-manual.html
-documentation/user-manual/user-manual.pdf
-documentation/user-manual/user-manual.tgz
+/documentation/*/eclipse/
+/documentation/bsp-guide/bsp-guide.html
+/documentation/bsp-guide/bsp-guide.pdf
+/documentation/bsp-guide/bsp-guide.tgz
+/documentation/dev-manual/dev-manual.html
+/documentation/dev-manual/dev-manual.pdf
+/documentation/dev-manual/dev-manual.tgz
+/documentation/kernel-dev/kernel-dev.html
+/documentation/kernel-dev/kernel-dev.pdf
+/documentation/kernel-dev/kernel-dev.tgz
+/documentation/mega-manual/mega-manual.html
+/documentation/mega-manual/mega-manual.tgz
+/documentation/profile-manual/profile-manual.html
+/documentation/profile-manual/profile-manual.pdf
+/documentation/profile-manual/profile-manual.tgz
+/documentation/ref-manual/ref-manual.html
+/documentation/ref-manual/ref-manual.pdf
+/documentation/ref-manual/ref-manual.tgz
+/documentation/sdk-manual/sdk-manual.html
+/documentation/sdk-manual/sdk-manual.pdf
+/documentation/sdk-manual/sdk-manual.tgz
+/documentation/toaster-manual/toaster-manual.html
+/documentation/toaster-manual/toaster-manual.tgz
+/documentation/user-manual/user-manual.html
+/documentation/user-manual/user-manual.pdf
+/documentation/user-manual/user-manual.tgz
+/documentation/yocto-project-qs/yocto-project-qs.html
+/documentation/yocto-project-qs/yocto-project-qs.tgz
 pull-*/
 bitbake/lib/toaster/contrib/tts/backlog.txt
 bitbake/lib/toaster/contrib/tts/log/*
-- 
2.11.0

Re: [PATCH] gitignore: ignore documentation build products

[Alexander Kanavin]

On 12/15/2017 12:52 PM, Sascha Silbe wrote:

> +/documentation/bsp-guide/bsp-guide.html
> +/documentation/bsp-guide/bsp-guide.pdf
> +/documentation/bsp-guide/bsp-guide.tgz
> +/documentation/dev-manual/dev-manual.html
> +/documentation/dev-manual/dev-manual.pdf
> +/documentation/dev-manual/dev-manual.tgz

You can condense these into much fewer amount of entries using *, I think?

Alex

Re: [PATCH] gitignore: ignore documentation build products

[Sascha Silbe]

[-- Attachment #1: Type: text/plain, Size: 1219 bytes --]

Dear Alexander,

Alexander Kanavin <alexander.kanavin@linux.intel.com> writes:

> On 12/15/2017 12:52 PM, Sascha Silbe wrote:
>
>> +/documentation/bsp-guide/bsp-guide.html
>> +/documentation/bsp-guide/bsp-guide.pdf
>> +/documentation/bsp-guide/bsp-guide.tgz
>> +/documentation/dev-manual/dev-manual.html
>> +/documentation/dev-manual/dev-manual.pdf
>> +/documentation/dev-manual/dev-manual.tgz
>
> You can condense these into much fewer amount of entries using *, I think?

I've thought about that but e.g. /documentation/*/*.html would risk
excluding future manually edited files as well, not just the build
output. If source and build directory were different that would be much
less of a concern but the documentation doesn't use a separate build
directory. And unfortunately git only supports fnmatch() style patterns
in .gitignore, not bash-style brace expansion or regular expressions.

But if you're certain there won't be manually edited HTML or PDF files
in the future and would prefer a more compact solution I'm happy to
switch to using wildcards.

Sascha
-- 
Softwareentwicklung Sascha Silbe, Niederhofenstraße 5/1, 71229 Leonberg
https://se-silbe.de/
USt-IdNr.: DE281696641

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 836 bytes --]

Re: [PATCH] gitignore: ignore documentation build products

[Alexander Kanavin]

On 12/15/2017 04:15 PM, Sascha Silbe wrote:

> But if you're certain there won't be manually edited HTML or PDF files
> in the future and would prefer a more compact solution I'm happy to
> switch to using wildcards.

I think this should be fine, yes.

Alex

[PATCH v2] gitignore: ignore documentation build products

[Sascha Silbe]

There are several different manuals by now, all of which produce
output. The "eclipse" directory might even have been present the last
time .gitignore was updated.

Ignore the files and directories that can be generated during "make
DOC=<directory>" as well as "make DOC=<directory> pdf". While at it,
make sure the patterns only match for the top-level documentation
directory.

Signed-off-by: Sascha Silbe <x-yo17@se-silbe.de>
---
v1→v2:
  - condense single-file rules into wildcard rules

 .gitignore | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/.gitignore b/.gitignore
index 94894d498c..0c4e112d9d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,9 +18,10 @@ hob-image-*.bb
 !meta-yocto
 !meta-yocto-bsp
 !meta-yocto-imported
-documentation/user-manual/user-manual.html
-documentation/user-manual/user-manual.pdf
-documentation/user-manual/user-manual.tgz
+/documentation/*/eclipse/
+/documentation/*/*.html
+/documentation/*/*.pdf
+/documentation/*/*.tgz
 pull-*/
 bitbake/lib/toaster/contrib/tts/backlog.txt
 bitbake/lib/toaster/contrib/tts/log/*
-- 
2.11.0