diff mbox series

Simplify the .gitignore file

Message ID 20200907174255.179652-1-thuth@redhat.com
State Superseded
Headers show
Series Simplify the .gitignore file | expand

Commit Message

Thomas Huth Sept. 7, 2020, 5:42 p.m. UTC
Now that we always do out-of-tree builds (and the in-tree builds are
faked via a "build" directory), we can simplify out .gitignore file
quite a bit.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 .gitignore | 158 -----------------------------------------------------
 1 file changed, 158 deletions(-)

Comments

Eric Blake Sept. 8, 2020, 12:50 p.m. UTC | #1
On 9/7/20 12:42 PM, Thomas Huth wrote:
> Now that we always do out-of-tree builds (and the in-tree builds are
> faked via a "build" directory), we can simplify out .gitignore file

s/out/our/

> quite a bit.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>   .gitignore | 158 -----------------------------------------------------
>   1 file changed, 158 deletions(-)
> 

I like the idea.  As Phillipe pointed out, there are still a few files 
that may be created by merely running './configure' or common editor 
droppings or workflow setups that are still worth ignoring, but as most 
of these truly no longer appear during a fresh checkout, it makes sense 
to clean it up.

Someone who still wants to use 'fake in-tree' builds and creates 
symlinks for themselves will no longer have those symlinks ignored by 
this pruned file, but can edit their own .git/info/exclude file to match 
their preferences.

> diff --git a/.gitignore b/.gitignore
> index 4ccb9ed975..bb916594eb 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -1,165 +1,7 @@
>   /GNUmakefile
>   /build/

Our 'fake in-tree' build uses just 'build', but ignoring '/build*/' 
might be wiser to automatically ignore all other variations on the theme 
of a subdirectory per build.
Thomas Huth Sept. 8, 2020, 2:50 p.m. UTC | #2
On 08/09/2020 16.41, Thomas Huth wrote:
> On 07/09/2020 21.43, Philippe Mathieu-Daudé wrote:
>> On 9/7/20 7:42 PM, Thomas Huth wrote:
>>> Now that we always do out-of-tree builds (and the in-tree builds are
>>> faked via a "build" directory), we can simplify out .gitignore file
>>> quite a bit.
>>>
>>> Signed-off-by: Thomas Huth <thuth@redhat.com>
>>> ---
>>>  .gitignore | 158 -----------------------------------------------------
>>>  1 file changed, 158 deletions(-)
>>>
>>> diff --git a/.gitignore b/.gitignore
>>> index 4ccb9ed975..bb916594eb 100644
>>> --- a/.gitignore
>>> +++ b/.gitignore
>>> @@ -1,165 +1,7 @@
>>>  /GNUmakefile
>>>  /build/
>>> -/.doctrees
>>> -/config-devices.*
>>> -/config-all-devices.*
>>> -/config-all-disas.*
>>> -/config-host.*
>>> -/config-target.*
>>> -/config.status
>>> -/config-temp
>>> -/tools/virtiofsd/50-qemu-virtiofsd.json
>>> -/elf2dmp
>>> -/trace-events-all
>>> -/trace/generated-events.h
>>> -/trace/generated-events.c
>>> -/trace/generated-helpers-wrappers.h
>>> -/trace/generated-helpers.h
>>> -/trace/generated-helpers.c
>>> -/trace/generated-tcg-tracers.h
>>> -/ui/shader/texture-blit-frag.h
>>> -/ui/shader/texture-blit-vert.h
>>> -/ui/shader/texture-blit-flip-vert.h
>>> -/ui/input-keymap-*.c.inc
>>> -*-timestamp
>>> -/*-softmmu
>>> -/*-darwin-user
>>> -/*-linux-user
>>> -/*-bsd-user
>>> -/ivshmem-client
>>> -/ivshmem-server
>>> -/libdis*
>>> -/libuser
>>> -/linux-headers/asm
>>> -/qga/qapi-generated
>>> -/qapi-gen-timestamp
>>> -/qapi/qapi-builtin-types.[ch]
>>> -/qapi/qapi-builtin-visit.[ch]
>>> -/qapi/qapi-commands-*.[ch]
>>> -**/qapi/qapi-commands.[ch]
>>> -**/qapi/qapi-emit-events.[ch]
>>> -/qapi/qapi-events-*.[ch]
>>> -**/qapi/qapi-events.[ch]
>>> -**/qapi/qapi-init-commands.[ch]
>>> -**/qapi/qapi-introspect.[ch]
>>> -/qapi/qapi-types-*.[ch]
>>> -**/qapi/qapi-types.[ch]
>>> -/qapi/qapi-visit-*.[ch]
>>> -!/qapi/qapi-visit-core.c
>>> -**/qapi/qapi-visit.[ch]
>>> -**/qapi/qapi-doc.texi
>>> -/qemu-edid
>>> -/qemu-img
>>> -/qemu-nbd
>>> -/qemu-options.def
>>> -/qemu-options.texi
>>> -/qemu-img-cmds.texi
>>> -/qemu-img-cmds.h
>>> -/qemu-io
>>> -/qemu-ga
>>> -/qemu-bridge-helper
>>> -/qemu-keymap
>>> -/qemu-monitor.texi
>>> -/qemu-monitor-info.texi
>>> -/qemu-storage-daemon
>>> -/qemu-version.h
>>> -/qemu-version.h.tmp
>>> -/module_block.h
>>> -/scsi/qemu-pr-helper
>>> -/vhost-user-scsi
>>> -/vhost-user-blk
>>> -/vhost-user-gpu
>>> -/vhost-user-input
>>> -/fsdev/virtfs-proxy-helper
>>> -*.tmp
>>
>> I'm not sure about this one.
> 
> According to git blame, it has been added in commit b8bd2f598b7 for
> tests/vm images.

I forgot to add: These are properly created in the build directory, so
it is fine to remove this line.

 Thomas
Markus Armbruster Sept. 9, 2020, 7:24 a.m. UTC | #3
Thomas Huth <thuth@redhat.com> writes:

> On 07/09/2020 21.43, Philippe Mathieu-Daudé wrote:
>> On 9/7/20 7:42 PM, Thomas Huth wrote:
>>> Now that we always do out-of-tree builds (and the in-tree builds are
>>> faked via a "build" directory), we can simplify out .gitignore file
>>> quite a bit.
>>>
>>> Signed-off-by: Thomas Huth <thuth@redhat.com>
>>> ---
>>>  .gitignore | 158 -----------------------------------------------------
>>>  1 file changed, 158 deletions(-)
>>>
>>> diff --git a/.gitignore b/.gitignore
>>> index 4ccb9ed975..bb916594eb 100644
>>> --- a/.gitignore
>>> +++ b/.gitignore
[...]
>>> -*.[1-9]
>>> -*.a
>>> -*.aux
>>> -*.cp
>>> -*.exe
>>> -*.msi
>>> -*.dll
>>> -*.so
>>> -*.fn
>>> -*.ky
>> 
>> Need to double-check where this come from.
>
> Looking at 0cb3fb1e30a7789881e18 and some other commits, it seems like
> these were once used for the qemu-doc PDF file generation. Should be ok
> to remove them now since we moved to Sphinx.

The move isn't complete, yet: "[PATCH v5 00/20] Convert QAPI doc
comments to generate rST instead of texinfo".

Regardless, formatting documentation should not litter the source tree.

[...]
Thomas Huth Sept. 9, 2020, 7:58 a.m. UTC | #4
On 08/09/2020 14.50, Eric Blake wrote:
> On 9/7/20 12:42 PM, Thomas Huth wrote:
>> Now that we always do out-of-tree builds (and the in-tree builds are
>> faked via a "build" directory), we can simplify out .gitignore file
> 
> s/out/our/
> 
>> quite a bit.
>>
>> Signed-off-by: Thomas Huth <thuth@redhat.com>
>> ---
>>   .gitignore | 158 -----------------------------------------------------
>>   1 file changed, 158 deletions(-)
>>
> 
> I like the idea.  As Phillipe pointed out, there are still a few files
> that may be created by merely running './configure' or common editor
> droppings or workflow setups that are still worth ignoring, but as most
> of these truly no longer appear during a fresh checkout, it makes sense
> to clean it up.
> 
> Someone who still wants to use 'fake in-tree' builds and creates
> symlinks for themselves will no longer have those symlinks ignored by
> this pruned file, but can edit their own .git/info/exclude file to match
> their preferences.
> 
>> diff --git a/.gitignore b/.gitignore
>> index 4ccb9ed975..bb916594eb 100644
>> --- a/.gitignore
>> +++ b/.gitignore
>> @@ -1,165 +1,7 @@
>>   /GNUmakefile
>>   /build/
> 
> Our 'fake in-tree' build uses just 'build', but ignoring '/build*/'
> might be wiser to automatically ignore all other variations on the theme
> of a subdirectory per build.

At least I am doing my out-of-tree builds completely outside of the
source tree. I think if someone wants to use directories within the
source tree for this, they can also simply add them to their private
.gitignore / .git/info/exclude file instead, then you're also more
flexible with the naming.

 Thomas
diff mbox series

Patch

diff --git a/.gitignore b/.gitignore
index 4ccb9ed975..bb916594eb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,165 +1,7 @@ 
 /GNUmakefile
 /build/
-/.doctrees
-/config-devices.*
-/config-all-devices.*
-/config-all-disas.*
-/config-host.*
-/config-target.*
-/config.status
-/config-temp
-/tools/virtiofsd/50-qemu-virtiofsd.json
-/elf2dmp
-/trace-events-all
-/trace/generated-events.h
-/trace/generated-events.c
-/trace/generated-helpers-wrappers.h
-/trace/generated-helpers.h
-/trace/generated-helpers.c
-/trace/generated-tcg-tracers.h
-/ui/shader/texture-blit-frag.h
-/ui/shader/texture-blit-vert.h
-/ui/shader/texture-blit-flip-vert.h
-/ui/input-keymap-*.c.inc
-*-timestamp
-/*-softmmu
-/*-darwin-user
-/*-linux-user
-/*-bsd-user
-/ivshmem-client
-/ivshmem-server
-/libdis*
-/libuser
-/linux-headers/asm
-/qga/qapi-generated
-/qapi-gen-timestamp
-/qapi/qapi-builtin-types.[ch]
-/qapi/qapi-builtin-visit.[ch]
-/qapi/qapi-commands-*.[ch]
-**/qapi/qapi-commands.[ch]
-**/qapi/qapi-emit-events.[ch]
-/qapi/qapi-events-*.[ch]
-**/qapi/qapi-events.[ch]
-**/qapi/qapi-init-commands.[ch]
-**/qapi/qapi-introspect.[ch]
-/qapi/qapi-types-*.[ch]
-**/qapi/qapi-types.[ch]
-/qapi/qapi-visit-*.[ch]
-!/qapi/qapi-visit-core.c
-**/qapi/qapi-visit.[ch]
-**/qapi/qapi-doc.texi
-/qemu-edid
-/qemu-img
-/qemu-nbd
-/qemu-options.def
-/qemu-options.texi
-/qemu-img-cmds.texi
-/qemu-img-cmds.h
-/qemu-io
-/qemu-ga
-/qemu-bridge-helper
-/qemu-keymap
-/qemu-monitor.texi
-/qemu-monitor-info.texi
-/qemu-storage-daemon
-/qemu-version.h
-/qemu-version.h.tmp
-/module_block.h
-/scsi/qemu-pr-helper
-/vhost-user-scsi
-/vhost-user-blk
-/vhost-user-gpu
-/vhost-user-input
-/fsdev/virtfs-proxy-helper
-*.tmp
-*.[1-9]
-*.a
-*.aux
-*.cp
-*.exe
-*.msi
-*.dll
-*.so
-*.fn
-*.ky
-*.log
-*.pdf
-*.pod
-*.cps
-*.fns
-*.kys
-*.pg
-*.pyc
-*.toc
-*.tp
-*.vr
-*.d
-!/.gitlab-ci.d
-!/scripts/qemu-guest-agent/fsfreeze-hook.d
-*.o
-.sdk
-*.gcda
-*.gcno
-*.gcov
-/pc-bios/bios-pq/status
-/pc-bios/edk2-*.fd
-/pc-bios/vgabios-pq/status
-/pc-bios/optionrom/linuxboot.asm
-/pc-bios/optionrom/linuxboot.bin
-/pc-bios/optionrom/linuxboot.raw
-/pc-bios/optionrom/linuxboot.img
-/pc-bios/optionrom/linuxboot_dma.asm
-/pc-bios/optionrom/linuxboot_dma.bin
-/pc-bios/optionrom/linuxboot_dma.raw
-/pc-bios/optionrom/linuxboot_dma.img
-/pc-bios/optionrom/pvh.asm
-/pc-bios/optionrom/pvh.bin
-/pc-bios/optionrom/pvh.raw
-/pc-bios/optionrom/pvh.img
-/pc-bios/optionrom/multiboot.asm
-/pc-bios/optionrom/multiboot.bin
-/pc-bios/optionrom/multiboot.raw
-/pc-bios/optionrom/multiboot.img
-/pc-bios/optionrom/kvmvapic.asm
-/pc-bios/optionrom/kvmvapic.bin
-/pc-bios/optionrom/kvmvapic.raw
-/pc-bios/optionrom/kvmvapic.img
-/pc-bios/s390-ccw/s390-ccw.elf
-/pc-bios/s390-ccw/s390-ccw.img
-/docs/built
-/docs/interop/qemu-ga-qapi.texi
-/docs/interop/qemu-ga-ref.html
-/docs/interop/qemu-ga-ref.info*
-/docs/interop/qemu-ga-ref.txt
-/docs/interop/qemu-qmp-qapi.texi
-/docs/interop/qemu-qmp-ref.html
-/docs/interop/qemu-qmp-ref.info*
-/docs/interop/qemu-qmp-ref.txt
-/docs/version.texi
-/contrib/vhost-user-gpu/50-qemu-gpu.json
-*.tps
-.stgit-*
 .git-submodule-status
 cscope.*
 tags
 TAGS
-docker-src.*
 *~
-*.ast_raw
-*.depend_raw
-trace.c
-trace-ust.h
-trace-ust.h
-trace-dtrace.h
-trace-dtrace.dtrace
-trace-root.h
-trace-root.c
-trace-ust-root.h
-trace-ust-root.h
-trace-ust-all.h
-trace-ust-all.c
-trace-dtrace-root.h
-trace-dtrace-root.dtrace
-trace-ust-all.h
-trace-ust-all.c
-/target/arm/decode-sve.c.inc