[PATCH 5/5] gitignore: Add a few forgotten file patterns
Add a few patterns to .gitignore to cover files which are generated
by building grub ("make", "make check", "make dist") but which have
been forgotten in the past.
Signed-off-by: Hans Ulrich Niedermann
---
.gitignore | 33 +
1 file changed, 33 insertions(+)
diff --git a/.gitignore b/.gitignore
index 50a023205..678e829aa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -59,6 +59,7 @@ widthspec.bin
/10_*
/20_linux_xen
/30_os-prober
+/30_uefi-firmware
/40_custom
/41_custom
/ABOUT-NLS
@@ -66,11 +67,13 @@ widthspec.bin
/ahci_test
/ascii.h
/autom4te.cache/
+/btrfs_test
/build-aux/
/build-grub-gen-asciih
/build-grub-gen-widthspec
/build-grub-mkfont
/cdboot_test
+/ChangeLog
/cmp_test
/compile
/config-util.h
@@ -83,8 +86,11 @@ widthspec.bin
/config.sub
/configure
/core_compress_test
+/cpio_test
+/date_test
/depcomp
/docs/*.info
+/docs/*.info-[0-9]*
/docs/stamp-1
/docs/stamp-vti
/docs/version-dev.texi
@@ -93,11 +99,18 @@ widthspec.bin
/example_grub_script_test
/example_scripted_test
/example_unit_test
+/exfat_test
+/ext234_test
+/f2fs_test
+/fat_test
/fddboot_test
+/file_filter_test
/garbage-gen
/garbage-gen.exe
/gettext_strings_test
/gnulib
+/grub-2.[0-9]*/
+/grub-2.[0-9]*.tar.gz
/grub-bios-setup
/grub-bios-setup.exe
/grub_cmd_date
@@ -105,6 +118,8 @@ widthspec.bin
/grub_cmd_regexp
/grub_cmd_set_date
/grub_cmd_sleep
+/grub_cmd_test
+/grub_cmd_tr
/grub-core/*.module
/grub-core/*.module.exe
/grub-core/*.pp
@@ -196,20 +211,27 @@ widthspec.bin
/gzcompress_test
/hddboot_test
/help_test
+/hfs_test
+/hfsplus_test
/INSTALL.grub
/install-sh
/include/grub/cpu
/include/grub/gcrypt/g10lib.h
/include/grub/gcrypt/gcrypt.h
/include/grub/machine
+/iso9660_test
+/jfs_test
/lib/libgcrypt-grub
/libgrub_a_init.c
/lzocompress_test
/m4/
/Makefile.util.am
/Makefile.utilgcry.def
+/minixfs_test
/missing
/netboot_test
+/nilfs2_test
+/ntfs_test
/ohci_test
/partmap_test
/pata_test
@@ -230,11 +252,22 @@ widthspec.bin
/printf_test
/priority_queue_unit_test
/pseries_test
+/reiserfs_test
+/romfs_test
+/squashfs_test
/stamp-h
/stamp-h.in
/stamp-h1
+/syslinux_test
+/tar_test
+/test_sha512sum
+/test_unset
+/tests/syslinux/ubuntu10.04_grub.cfg
/texinfo.tex
+/udf_test
/uhci_test
/util/bash-completion.d/grub
/widthspec.h
+/xfs_test
/xzcompress_test
+/zfs_test
--
2.25.3
___
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel
[PATCH 4/5] gitignore: Add leading slashes where appropriate
Going through the list of gitignore patterns without a slash, this adds a leading slash where it appears to have been forgotten. Some gitignore patterns like .deps/ or Makefile clearly should match everywhere, so those definitively need no leading slash. For some patterns like contrib or ascii.bitmaps, it is unclear where in the source tree they should match. Those patterns are kept as they are, matching the patterns in the whole tree of subdirectories. Signed-off-by: Hans Ulrich Niedermann --- .gitignore | 234 ++--- 1 file changed, 117 insertions(+), 117 deletions(-) diff --git a/.gitignore b/.gitignore index 7e1d32df4..50a023205 100644 --- a/.gitignore +++ b/.gitignore @@ -16,167 +16,95 @@ *.pp *.trs *~ -.deps -.deps-core -.deps-util +.deps/ +.deps-core/ +.deps-util/ .dirstamp -00_header -10_* -20_linux_xen -30_os-prober -40_custom -41_custom -ABOUT-NLS DISTLIST GPATH GRTAGS GSYMS GTAGS -INSTALL.grub Makefile Makefile.in -Makefile.util.am -Makefile.utilgcry.def -aclocal.m4 -ahci_test ascii.bitmaps -ascii.h -autom4te.cache -build-aux -build-grub-gen-asciih -build-grub-gen-widthspec -build-grub-mkfont -cdboot_test -cmp_test -compile -config-util.h -config-util.h.in -config.cache -config.guess -config.h -config.log -config.status -config.sub -configure contrib -core_compress_test -depcomp -ehci_test -example_grub_script_test -example_scripted_test -example_unit_test -fddboot_test genkernsyms.sh gensymlist.sh -gentrigtables -gentrigtables.exe -gettext_strings_test grub-bin2h grub-emu grub-emu-lite grub-emu-lite.exe grub-emu.exe -grub-fstest -grub-fstest.exe -grub-install -grub-install.exe -grub-kbdcomp grub-macho2img -grub-mount -grub-script-check -grub-script-check.exe -grub-set-default -grub-shell -grub-shell-tester -grub-sparc64-setup -grub-sparc64-setup.exe -grub_cmd_date -grub_cmd_echo -grub_cmd_regexp -grub_cmd_set_date -grub_cmd_sleep grub_emu_init.c grub_emu_init.h -grub_fstest_init.c -grub_fstest_init.h -grub_func_test grub_probe_init.c -grub_probe_init.h +grub_probe_inti.h grub_script.tab.c grub_script.tab.h grub_script.yy.c grub_script.yy.h -grub_script_blanklines -grub_script_blockarg -grub_script_break grub_script_check_init.c grub_script_check_init.h -grub_script_comments -grub_script_continue -grub_script_dollar -grub_script_echo1 -grub_script_echo_keywords -grub_script_escape_comma -grub_script_eval -grub_script_expansion -grub_script_final_semicolon -grub_script_for1 -grub_script_functions -grub_script_gettext -grub_script_if -grub_script_leading_whitespace -grub_script_no_commands -grub_script_not -grub_script_return -grub_script_setparams -grub_script_shift -grub_script_strcmp -grub_script_test -grub_script_vars1 -grub_script_while1 grub_setup_init.c grub_setup_init.h -gzcompress_test -hddboot_test -help_test -install-sh -libgrub_a_init.c -lzocompress_test mdate-sh -missing mod-*.c -netboot_test -ohci_test -partmap_test -pata_test -printf_test -priority_queue_unit_test -pseries_test -stamp-h -stamp-h.in -stamp-h1 -symlist.c -symlist.h -texinfo.tex -trigtables.c -uhci_test -unidata.c update-grub_lib widthspec.bin -widthspec.h -xzcompress_test # Ignore patterns relative to this .gitignore file's directory +/00_header +/10_* +/20_linux_xen +/30_os-prober +/40_custom +/41_custom +/ABOUT-NLS +/aclocal.m4 +/ahci_test +/ascii.h +/autom4te.cache/ +/build-aux/ +/build-grub-gen-asciih +/build-grub-gen-widthspec +/build-grub-mkfont +/cdboot_test +/cmp_test +/compile +/config-util.h +/config-util.h.in +/config.cache +/config.guess +/config.h +/config.log +/config.status +/config.sub +/configure +/core_compress_test +/depcomp /docs/*.info /docs/stamp-1 /docs/stamp-vti /docs/version-dev.texi /docs/version.texi +/ehci_test +/example_grub_script_test +/example_scripted_test +/example_unit_test +/fddboot_test /garbage-gen /garbage-gen.exe +/gettext_strings_test /gnulib /grub-bios-setup /grub-bios-setup.exe +/grub_cmd_date +/grub_cmd_echo +/grub_cmd_regexp +/grub_cmd_set_date +/grub_cmd_sleep /grub-core/*.module /grub-core/*.module.exe /grub-core/*.pp @@ -189,6 +117,8 @@ xzcompress_test /grub-core/gdb_grub /grub-core/genmod.sh /grub-core/gensyminfo.sh +/grub-core/gentrigtables +/grub-core/gentrigtables.exe /grub-core/gmodule.pl /grub-core/grub.chrp /grub-core/kernel.img.bin @@ -196,18 +126,31 @@ xzcompress_test /grub-core/lib/libgcrypt-grub /grub-core/modinfo.sh /grub-core/rs_decoder.h +/grub-core/symlist.c +/grub-core/symlist.h +/grub-core/trigtables.c +/grub-core/unidata.c /grub-editenv /grub-editenv.exe /grub-file /grub-file.exe /grub-fs-tester +/grub-fstest +/grub-fstest.exe +/grub_fstest_init.c +/grub_fstest_init.h +/grub_func_test /grub-glue-efi /grub-glue-efi.exe +/grub-install +/grub-install.exe +/grub-kbdcomp /grub-macbless /grub-macbless.exe /grub-menulst2cfg /grub-menulst2cfg.exe /grub-mk* +/grub-mount /grub-ofpathname /grub-ofpathname.exe /grub-probe @@ -215,14
[PATCH 3/5] gitignore: Consistent leading slash is easier to read
As all gitignore patterns containing a left or middle slash match only relative to the .gitignore file's directory, we write them all in the same manner with a leading slash. This makes the file significantly easier to read. Signed-off-by: Hans Ulrich Niedermann --- .gitignore | 88 +++--- 1 file changed, 44 insertions(+), 44 deletions(-) diff --git a/.gitignore b/.gitignore index 0f6d6dd4e..7e1d32df4 100644 --- a/.gitignore +++ b/.gitignore @@ -167,35 +167,35 @@ widthspec.h xzcompress_test # Ignore patterns relative to this .gitignore file's directory -docs/*.info -docs/stamp-1 -docs/stamp-vti -docs/version-dev.texi -docs/version.texi +/docs/*.info +/docs/stamp-1 +/docs/stamp-vti +/docs/version-dev.texi +/docs/version.texi /garbage-gen /garbage-gen.exe /gnulib /grub-bios-setup /grub-bios-setup.exe -grub-core/*.module -grub-core/*.module.exe -grub-core/*.pp -grub-core/Makefile.core.am -grub-core/Makefile.gcry.def -grub-core/bootinfo.txt -grub-core/build-grub-module-verifier -grub-core/build-grub-pe2elf.exe -grub-core/contrib -grub-core/gdb_grub -grub-core/genmod.sh -grub-core/gensyminfo.sh -grub-core/gmodule.pl -grub-core/grub.chrp -grub-core/kernel.img.bin -grub-core/lib/gnulib -grub-core/lib/libgcrypt-grub -grub-core/modinfo.sh -grub-core/rs_decoder.h +/grub-core/*.module +/grub-core/*.module.exe +/grub-core/*.pp +/grub-core/Makefile.core.am +/grub-core/Makefile.gcry.def +/grub-core/bootinfo.txt +/grub-core/build-grub-module-verifier +/grub-core/build-grub-pe2elf.exe +/grub-core/contrib +/grub-core/gdb_grub +/grub-core/genmod.sh +/grub-core/gensyminfo.sh +/grub-core/gmodule.pl +/grub-core/grub.chrp +/grub-core/kernel.img.bin +/grub-core/lib/gnulib +/grub-core/lib/libgcrypt-grub +/grub-core/modinfo.sh +/grub-core/rs_decoder.h /grub-editenv /grub-editenv.exe /grub-file @@ -217,24 +217,24 @@ grub-core/rs_decoder.h /grub-render-label.exe /grub-syslinux2cfg /grub-syslinux2cfg.exe -include/grub/cpu -include/grub/gcrypt/g10lib.h -include/grub/gcrypt/gcrypt.h -include/grub/machine -lib/libgcrypt-grub +/include/grub/cpu +/include/grub/gcrypt/g10lib.h +/include/grub/gcrypt/gcrypt.h +/include/grub/machine +/lib/libgcrypt-grub /m4 -po/*.gmo -po/*.mo -po/*.po -po/LINGUAS -po/Makefile.in.in -po/Makevars -po/Makevars.template -po/POTFILES -po/POTFILES-shell.in -po/POTFILES.in -po/Rules-quot -po/grub.pot -po/remove-potcdate.sed -po/stamp-po -util/bash-completion.d/grub +/po/*.gmo +/po/*.mo +/po/*.po +/po/LINGUAS +/po/Makefile.in.in +/po/Makevars +/po/Makevars.template +/po/POTFILES +/po/POTFILES-shell.in +/po/POTFILES.in +/po/Rules-quot +/po/grub.pot +/po/remove-potcdate.sed +/po/stamp-po +/util/bash-completion.d/grub -- 2.25.3 ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
[PATCH 2/5] gitignore: Sort both pattern groups alphabetically
Alphabetically sort the two groups of gitignore patterns: * The group of patterns with slashes, matching relative to the .gitignore file's directory * The group of patterns without slashes, matching anywhere in the directory subtree. Signed-off-by: Hans Ulrich Niedermann --- .gitignore | 200 ++--- 1 file changed, 100 insertions(+), 100 deletions(-) diff --git a/.gitignore b/.gitignore index 87280ba24..0f6d6dd4e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,14 +1,42 @@ # Ignore patterns in this directory and all subdirectories +*.1 +*.8 +*.a +*.exec +*.exec.exe +*.image +*.image.exe +*.img +*.log +*.lst +*.marker +*.mod +*.o +*.pf2 +*.pp +*.trs *~ +.deps +.deps-core +.deps-util +.dirstamp 00_header 10_* 20_linux_xen 30_os-prober 40_custom 41_custom -*.1 -*.8 ABOUT-NLS +DISTLIST +GPATH +GRTAGS +GSYMS +GTAGS +INSTALL.grub +Makefile +Makefile.in +Makefile.util.am +Makefile.utilgcry.def aclocal.m4 ahci_test ascii.bitmaps @@ -20,23 +48,23 @@ build-grub-gen-widthspec build-grub-mkfont cdboot_test cmp_test +compile +config-util.h +config-util.h.in config.cache config.guess config.h -config-util.h -config-util.h.in config.log config.status config.sub configure +contrib core_compress_test -DISTLIST +depcomp ehci_test example_grub_script_test example_scripted_test example_unit_test -*.exec -*.exec.exe fddboot_test genkernsyms.sh gensymlist.sh @@ -44,34 +72,43 @@ gentrigtables gentrigtables.exe gettext_strings_test grub-bin2h -grub_cmd_date -grub_cmd_echo -grub_cmd_regexp -grub_cmd_set_date -grub_cmd_sleep grub-emu grub-emu-lite -grub-emu.exe grub-emu-lite.exe -grub_emu_init.c -grub_emu_init.h +grub-emu.exe grub-fstest grub-fstest.exe -grub_fstest_init.c -grub_fstest_init.h -grub_func_test grub-install grub-install.exe grub-kbdcomp grub-macho2img grub-mount +grub-script-check +grub-script-check.exe +grub-set-default +grub-shell +grub-shell-tester +grub-sparc64-setup +grub-sparc64-setup.exe +grub_cmd_date +grub_cmd_echo +grub_cmd_regexp +grub_cmd_set_date +grub_cmd_sleep +grub_emu_init.c +grub_emu_init.h +grub_fstest_init.c +grub_fstest_init.h +grub_func_test grub_probe_init.c grub_probe_init.h +grub_script.tab.c +grub_script.tab.h +grub_script.yy.c +grub_script.yy.h grub_script_blanklines grub_script_blockarg grub_script_break -grub-script-check -grub-script-check.exe grub_script_check_init.c grub_script_check_init.h grub_script_comments @@ -97,86 +134,75 @@ grub_script_strcmp grub_script_test grub_script_vars1 grub_script_while1 -grub_script.tab.c -grub_script.tab.h -grub_script.yy.c -grub_script.yy.h -grub-set-default grub_setup_init.c grub_setup_init.h -grub-shell -grub-shell-tester -grub-sparc64-setup -grub-sparc64-setup.exe gzcompress_test hddboot_test help_test -*.img -*.image -*.image.exe -INSTALL.grub install-sh libgrub_a_init.c -*.log -*.lst lzocompress_test -*.marker -Makefile -*.mod -mod-*.c +mdate-sh missing +mod-*.c netboot_test -*.o -*.a ohci_test partmap_test pata_test -*.pf2 -*.pp printf_test priority_queue_unit_test pseries_test stamp-h -stamp-h1 stamp-h.in +stamp-h1 symlist.c symlist.h +texinfo.tex trigtables.c -*.trs uhci_test -update-grub_lib unidata.c -xzcompress_test -Makefile.in -GPATH -GRTAGS -GSYMS -GTAGS -compile -depcomp -mdate-sh -texinfo.tex -.deps -.deps-util -.deps-core -.dirstamp -Makefile.util.am -contrib +update-grub_lib widthspec.bin widthspec.h -Makefile.utilgcry.def +xzcompress_test # Ignore patterns relative to this .gitignore file's directory docs/*.info +docs/stamp-1 docs/stamp-vti +docs/version-dev.texi docs/version.texi +/garbage-gen +/garbage-gen.exe /gnulib /grub-bios-setup /grub-bios-setup.exe +grub-core/*.module +grub-core/*.module.exe +grub-core/*.pp +grub-core/Makefile.core.am +grub-core/Makefile.gcry.def +grub-core/bootinfo.txt +grub-core/build-grub-module-verifier +grub-core/build-grub-pe2elf.exe +grub-core/contrib +grub-core/gdb_grub +grub-core/genmod.sh +grub-core/gensyminfo.sh +grub-core/gmodule.pl +grub-core/grub.chrp +grub-core/kernel.img.bin +grub-core/lib/gnulib +grub-core/lib/libgcrypt-grub +grub-core/modinfo.sh +grub-core/rs_decoder.h /grub-editenv /grub-editenv.exe /grub-file /grub-file.exe +/grub-fs-tester +/grub-glue-efi +/grub-glue-efi.exe /grub-macbless /grub-macbless.exe /grub-menulst2cfg @@ -184,57 +210,31 @@ docs/version.texi /grub-mk* /grub-ofpathname /grub-ofpathname.exe -grub-core/build-grub-pe2elf.exe /grub-probe /grub-probe.exe /grub-reboot +/grub-render-label +/grub-render-label.exe /grub-syslinux2cfg /grub-syslinux2cfg.exe include/grub/cpu +include/grub/gcrypt/g10lib.h +include/grub/gcrypt/gcrypt.h include/grub/machine lib/libgcrypt-grub /m4 +po/*.gmo po/*.mo -po/grub.pot +po/*.po +po/LINGUAS po/Makefile.in.in po/Makevars po/Makevars.template po/POTFILES +po/POTFILES-shell.in +po/POTFILES.in po/Rules-quot +po/grub.pot +po/remove-potcdate.sed po/stamp-po
[PATCH 1/5] gitignore: Group patterns with and without slash
Group the .gitignore patterns into two groups: * Patterns including a slash, i.e. matching only relative to the .gitignore file's directory. * Pattern not including a slash, i.e. matching files anywhere in the .gitignore file's directory and all of its subdirectories. Signed-off-by: Hans Ulrich Niedermann --- .gitignore | 81 -- 1 file changed, 42 insertions(+), 39 deletions(-) diff --git a/.gitignore b/.gitignore index 819cd185d..87280ba24 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +# Ignore patterns in this directory and all subdirectories *~ 00_header 10_* @@ -30,9 +31,6 @@ config.sub configure core_compress_test DISTLIST -docs/*.info -docs/stamp-vti -docs/version.texi ehci_test example_grub_script_test example_scripted_test @@ -45,25 +43,18 @@ gensymlist.sh gentrigtables gentrigtables.exe gettext_strings_test -/gnulib grub-bin2h -/grub-bios-setup -/grub-bios-setup.exe grub_cmd_date grub_cmd_echo grub_cmd_regexp grub_cmd_set_date grub_cmd_sleep -/grub-editenv -/grub-editenv.exe grub-emu grub-emu-lite grub-emu.exe grub-emu-lite.exe grub_emu_init.c grub_emu_init.h -/grub-file -/grub-file.exe grub-fstest grub-fstest.exe grub_fstest_init.c @@ -72,21 +63,10 @@ grub_func_test grub-install grub-install.exe grub-kbdcomp -/grub-macbless -/grub-macbless.exe grub-macho2img -/grub-menulst2cfg -/grub-menulst2cfg.exe -/grub-mk* grub-mount -/grub-ofpathname -/grub-ofpathname.exe -grub-core/build-grub-pe2elf.exe -/grub-probe -/grub-probe.exe grub_probe_init.c grub_probe_init.h -/grub-reboot grub_script_blanklines grub_script_blockarg grub_script_break @@ -128,26 +108,20 @@ grub-shell grub-shell-tester grub-sparc64-setup grub-sparc64-setup.exe -/grub-syslinux2cfg -/grub-syslinux2cfg.exe gzcompress_test hddboot_test help_test *.img *.image *.image.exe -include/grub/cpu -include/grub/machine INSTALL.grub install-sh -lib/libgcrypt-grub libgrub_a_init.c *.log *.lst lzocompress_test *.marker Makefile -/m4 *.mod mod-*.c missing @@ -159,14 +133,6 @@ partmap_test pata_test *.pf2 *.pp -po/*.mo -po/grub.pot -po/Makefile.in.in -po/Makevars -po/Makevars.template -po/POTFILES -po/Rules-quot -po/stamp-po printf_test priority_queue_unit_test pseries_test @@ -190,13 +156,53 @@ compile depcomp mdate-sh texinfo.tex -grub-core/lib/libgcrypt-grub .deps .deps-util .deps-core .dirstamp Makefile.util.am contrib +widthspec.bin +widthspec.h +Makefile.utilgcry.def + +# Ignore patterns relative to this .gitignore file's directory +docs/*.info +docs/stamp-vti +docs/version.texi +/gnulib +/grub-bios-setup +/grub-bios-setup.exe +/grub-editenv +/grub-editenv.exe +/grub-file +/grub-file.exe +/grub-macbless +/grub-macbless.exe +/grub-menulst2cfg +/grub-menulst2cfg.exe +/grub-mk* +/grub-ofpathname +/grub-ofpathname.exe +grub-core/build-grub-pe2elf.exe +/grub-probe +/grub-probe.exe +/grub-reboot +/grub-syslinux2cfg +/grub-syslinux2cfg.exe +include/grub/cpu +include/grub/machine +lib/libgcrypt-grub +/m4 +po/*.mo +po/grub.pot +po/Makefile.in.in +po/Makevars +po/Makevars.template +po/POTFILES +po/Rules-quot +po/stamp-po +grub-core/lib/libgcrypt-grub grub-core/bootinfo.txt grub-core/Makefile.core.am grub-core/Makefile.gcry.def @@ -214,11 +220,8 @@ grub-core/kernel.img.bin util/bash-completion.d/grub grub-core/lib/gnulib grub-core/rs_decoder.h -widthspec.bin -widthspec.h docs/stamp-1 docs/version-dev.texi -Makefile.utilgcry.def po/*.po po/*.gmo po/LINGUAS -- 2.25.3 ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
[PATCH 0/5] gitignore: Clean up most of the gitignore mess
Daniel Kiper has asked me to provide the following set of four patches: 1. Split patterns into two groups. 2. Alphabetically sort the patterns within each group. 3. Add / to patterns which should have one. 4. Add missing patterns. However, I found that there was one step missing on the way to an easily readable .gitignore file, so I have added that additional step: 1. Split patterns into two groups. 2. Alphabetically sort the patterns within each group. 2a. Add leading / to all existing slash patterns. 3. Add / to patterns which should have one. 4. Add missing patterns. Some of the remaining no-slash patterns (i.e. those matching anywhere in the directory tree) might work with a leading slash, but I could not research all of them (especially for old code and optionally built files), so I have left those for now. Hans Ulrich Niedermann (5): gitignore: Group patterns with and without slash gitignore: Sort both pattern groups alphabetically gitignore: Consistent leading slash is easier to read gitignore: Add leading slashes where appropriate gitignore: Add a few forgotten file patterns .gitignore | 458 + 1 file changed, 247 insertions(+), 211 deletions(-) -- 2.25.3 ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
Re: How to submit patches and patchsets via grub-devel
Hi Hans, > Hello, > > as I am continuing to flood this mailing list with patches, I am > realizing that I am missing some general rules for how things work on > grub-devel. Sorry for the inconvenience caused by that. > > Anyway, here are a few questions I am beginning realize I should know > the answers to before posting patches to grub-devel: > > * What to put into the cover letter (git send-email --compose)? > > * How to format commit messages? > > * What about those special lines within commit messages? > > * Signed-off-by: > * Reviewed-by: > > Who adds these special lines and when? If Daniel replies to me > posting a patch with "Reviewed-by: Daniel", does that mean I should > include that in my next iteration of that patch? Does it mean > Daniel approves of the patch and plans to merge it to master > himself with or without adding the Reviewed-by by himself? > > Are there other special lines I need to be aware of? I don't know about grub specifically but these lines are extremely common in the linux kernel community, where they're documented at: (picking v4.17 as it came up first in the google search results and it's still pretty current) https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html Specifically: https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes I generally follow the kernel patch guidelines across any project I contribute to where appropriate - obviously in this case there are things like the GNU coding style rather than the linux coding style, so it's not all applicable! But I think the kernel guidance on patch format is extremely good and generally applicable - that might answer your first two questions. > > * How are reviews done? Is there a formal definition of preconditions > which must be satisfied before something is actually committed to > the master branch? Again, just in terms of kernel practice, see https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes Projects (and indeed different subsystems within the kernel) have different rules about what's formally required (e.g. is a Reviewed-by required, does the maintainer apply a reviewed-by tag or a signed-off-by tag) so I won't speak for Daniel K on this. > I presume a good place to write those down for grub would be > docs/grub-dev.texi. I had not intended to touch grub-dev.texi much > before 2.06, but apparently this needs to be done first so I can > properly do the other things for 2.06. Am I wrong in this presumption > and just missing the place where the general rules on how to contribute > patches are written down? > > Anyway, when I am finding out what those rules are I can start > writing them down without much additional effort, starting with what > Daniel replied to me in > <20200423100837.jllsb57rjitmd...@tomti.i.net-space.pl>. > > Please add to this list if you notice something missing from it, so I > can collect all that, write it up for docs/grub-dev.texi and post a > patch updating docs/grub-dev.texi in a week or two. > > So, here are the "how to submit patches via grub-devel" rules so far: > > * If you post more than one patch, create a cover email > (git send-email --compose ...). I tend to use git format-patch --cover-letter and then look over everything first - but most of my colleagues do it the way you've suggested. > > * Create a new email thread for a new patchset. Do not attach it > to existing email threads. > > * If you need to repost a patchset, repost the whole series of > patches as a new email thread instead of just reposting some > individual patches. > My personal opinion is that these are all excellent rules for all involved. Regards, Daniel > Thanks for your help. > > Uli > > ___ > Grub-devel mailing list > Grub-devel@gnu.org > https://lists.gnu.org/mailman/listinfo/grub-devel ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
Re: How to submit patches and patchsets via grub-devel
On 4/23/20 10:20 AM, Hans Ulrich Niedermann wrote: > Hello, > > as I am continuing to flood this mailing list with patches, I am > realizing that I am missing some general rules for how things work on > grub-devel. Sorry for the inconvenience caused by that. > > Anyway, here are a few questions I am beginning realize I should know > the answers to before posting patches to grub-devel: > > * What to put into the cover letter (git send-email --compose)? > > * How to format commit messages? > > * What about those special lines within commit messages? > > * Signed-off-by: > * Reviewed-by: > > Who adds these special lines and when? If Daniel replies to me > posting a patch with "Reviewed-by: Daniel", does that mean I should > include that in my next iteration of that patch? Does it mean > Daniel approves of the patch and plans to merge it to master > himself with or without adding the Reviewed-by by himself? > > Are there other special lines I need to be aware of? https://git.wiki.kernel.org/index.php/CommitMessageConventions#Trailers Different projects mean different things, but Signed-off-by is a common one: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin Reviewed-by is another convention originating in the kernel -- it indicates Daniel thinks the patch is good, and the person (in this case himself) who takes that patch and commits it to the project (or to the kernel subsystem for later merging into torvalds/linux.git) will include that line when committing -- there's no need to submit a v2/v3/etc patch with just this modification to the commit message. > * How are reviews done? Is there a formal definition of preconditions > which must be satisfied before something is actually committed to > the master branch? I'm not entirely sure what you're asking, but I'd guess "one or more project maintainers will reply to the patch, either approving the patch or asking for changes". But of course they're unlikely to approve a non-documentation patch without giving it a trial run and seeing it work. Is your question about what type of testing is done? > I presume a good place to write those down for grub would be > docs/grub-dev.texi. I had not intended to touch grub-dev.texi much > before 2.06, but apparently this needs to be done first so I can > properly do the other things for 2.06. Am I wrong in this presumption > and just missing the place where the general rules on how to contribute > patches are written down? I think it's more or less: - Some of these rules are passed along by word of mouth due to being de facto rules, and, while preferred, aren't hard requirements. - Some of these rules are commonly used in various projects, so people automatically assume everyone knows them, even though they don't. Then when someone asks "but what are the rules, anyway" there's a mad scramble to hunt down a description in someone else's documentation, often from kernel.org - Often, documentation doesn't get written down because it's obvious to the people who write documentation, and the people who need the docs don't know it. And in the case of procedural rules this is even more egregious, because you don't have code to point at to prove that it isn't documented. Then eventually someone who was unfamiliar with the process says "how about we document this" and everyone else is like "oh uh, yeah, that makes sense, we probably should have done this a long time ago". It's always nice to find a documentation file such as 'doc/submitting-patches.asciidoc' (or reStructuredText or texinfo or whatever the project uses) documenting the conventions, as well as any project-specific guidance. It will also usually tell you the email address for the appropriate mailing list. One example can be found here: https://www.archlinux.org/pacman/submitting-patches.html source: https://git.archlinux.org/pacman.git/tree/doc/submitting-patches.asciidoc Currently the grub-dev manual talks a lot about the coding style (similar in spirit to my HACKING.asciidoc/HACKING.html) and very little about how to submit patches. This information is definitely missing and I believe a patch to update it would be very appropriate. -- Eli Schwartz Arch Linux Bug Wrangler and Trusted User signature.asc Description: OpenPGP digital signature ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
How to submit patches and patchsets via grub-devel
Hello, as I am continuing to flood this mailing list with patches, I am realizing that I am missing some general rules for how things work on grub-devel. Sorry for the inconvenience caused by that. Anyway, here are a few questions I am beginning realize I should know the answers to before posting patches to grub-devel: * What to put into the cover letter (git send-email --compose)? * How to format commit messages? * What about those special lines within commit messages? * Signed-off-by: * Reviewed-by: Who adds these special lines and when? If Daniel replies to me posting a patch with "Reviewed-by: Daniel", does that mean I should include that in my next iteration of that patch? Does it mean Daniel approves of the patch and plans to merge it to master himself with or without adding the Reviewed-by by himself? Are there other special lines I need to be aware of? * How are reviews done? Is there a formal definition of preconditions which must be satisfied before something is actually committed to the master branch? I presume a good place to write those down for grub would be docs/grub-dev.texi. I had not intended to touch grub-dev.texi much before 2.06, but apparently this needs to be done first so I can properly do the other things for 2.06. Am I wrong in this presumption and just missing the place where the general rules on how to contribute patches are written down? Anyway, when I am finding out what those rules are I can start writing them down without much additional effort, starting with what Daniel replied to me in <20200423100837.jllsb57rjitmd...@tomti.i.net-space.pl>. Please add to this list if you notice something missing from it, so I can collect all that, write it up for docs/grub-dev.texi and post a patch updating docs/grub-dev.texi in a week or two. So, here are the "how to submit patches via grub-devel" rules so far: * If you post more than one patch, create a cover email (git send-email --compose ...). * Create a new email thread for a new patchset. Do not attach it to existing email threads. * If you need to repost a patchset, repost the whole series of patches as a new email thread instead of just reposting some individual patches. Thanks for your help. Uli ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
Re: [PATCH] docs: Fix numerous minor mistakes in grub.info
On Thu, Apr 16, 2020 at 15:03:44 +0200, Hans Ulrich Niedermann wrote:
> Fix minor mistakes like spelling errors, missing articles
> like 'a' and 'the', wrong word order, unnecessary trailing
> spaces, missing periods, and similar things.
>
> This patch does not change the intended meaning of the text
> and only touches about the first 1300 of about 7000 lines
> in docs/grub.texi.
>
> Signed-off-by: Hans Ulrich Niedermann
A couple of *additional* comments below (on text being changed), but
for all the changes:
Reviewed-by: Leif Lindholm
> ---
> docs/grub.texi | 66 +-
> 1 file changed, 33 insertions(+), 33 deletions(-)
>
> diff --git a/docs/grub.texi b/docs/grub.texi
> index 8e6f9acec..409619fb2 100644
> --- a/docs/grub.texi
> +++ b/docs/grub.texi
> @@ -376,10 +376,10 @@ Can decompress files which were compressed by
> @command{gzip} or
> is CRC64 so one should use --check=crc32 option). LZMA BCJ filters are
> supported.}. This function is both automatic and transparent to the user
> (i.e. all functions operate upon the uncompressed contents of the specified
> -files). This greatly reduces a file size and loading time, a
> +files). This greatly reduces file size and loading time, a
> particularly great benefit for floppies.@footnote{There are a few
> pathological cases where loading a very badly organized ELF kernel might
> -take longer, but in practice this never happen.}
> +take longer, but in practice this never happens.}
>
> It is conceivable that some kernel modules should be loaded in a
> compressed state, so a different module-loading command can be specified
> @@ -539,7 +539,7 @@ This specifies the file named @samp{vmlinuz}, found on
> the first
> partition of the first hard disk drive. Note that the argument
> completion works with file names, too.
>
> -That was easy, admit it. Now read the next chapter, to find out how to
> +That was easy, admit it. Now read the next chapter to find out how to
> actually install GRUB on your drive.
>
> @node OS-specific notes about grub tools
> @@ -827,7 +827,7 @@ The partition table format traditionally used on PC BIOS
> platforms is called
> the Master Boot Record (MBR) format; this is the format that allows up to
> four primary partitions and additional logical partitions. With this
> partition table format, there are two ways to install GRUB: it can be
> -embedded in the area between the MBR and the first partition (called by
> +embedded in the area between the MBR and the first partition (known by
> various names, such as the "boot track", "MBR gap", or "embedding area", and
> which is usually at least 31 KiB), or the core image can be installed in a
> file system and a list of the blocks that make it up can be stored in the
> @@ -904,7 +904,7 @@ magic.
>
> GRUB has two distinct boot methods. One of the two is to load an
> operating system directly, and the other is to chain-load another boot
> -loader which then will load an operating system actually. Generally
> +loader which then will actually load an operating system. Generally
I might also swap then/will here.
> speaking, the former is more desirable, because you don't need to
> install or maintain other boot loaders and GRUB is flexible enough to
> load an operating system from an arbitrary disk/partition. However,
> @@ -934,7 +934,7 @@ Run the command @command{boot} (@pxref{boot}).
> @end enumerate
>
> However, DOS and Windows have some deficiencies, so you might have to
> -use more complicated instructions. @xref{DOS/Windows}, for more
> +use more complicated instructions. @xref{DOS/Windows} for more
> information.
>
>
> @@ -980,17 +980,17 @@ by commands @command{kfreebsd_module},
> @command{knetbsd_module_elf},
> @command{multiboot2_module} or @command{xnu_ramdisk}
> depending on the loader. Note that for knetbsd the image must be put
> inside miniroot.kmod and the whole miniroot.kmod has to be loaded. In
> -kopenbsd payload this is disabled by default. Aditionally behaviour of
> -initial ramdisk depends on command line options. Several distributors provide
> +kopenbsd payload, this is disabled by default. Additionally, the behaviour of
> +initial ramdisks depends on command line options. Several distributors
> provide
I think the above text has more issues than what is being addressed
here and could do with some rework. (Passive voice is often
problematic in documentation.)
"behaviour" and "depends" both end up being quite ambiguous in this context.
Maybe something like:
"Additionally, command line options can affect both the use of initial
ramdisks and their runtime behaviour."
(If that is the message the original was trying to convey.)
> the image for this purpose or it's integrated in their standard ramdisk and
> activated by special option. Consult your kernel and distribution manual for
> more details. Other loaders like appleloader, chainloader (BIOS, EFI,
> coreboot),
> freedos,
Re: [PATCH] Don't run f2fs test on systems with PAGE_SIZE > 4KB
On Thu, Apr 23, 2020 at 12:10:07PM +0300, Anatoly Pugachev wrote: > On Tue, Jul 30, 2019 at 3:10 PM Anatoly Pugachev wrote: > > > > On Tue, Jul 30, 2019 at 1:00 PM John Paul Adrian Glaubitz > > wrote: > > > On 7/30/19 10:11 AM, Anatoly Pugachev wrote: > > > > don't run f2fs test on systems with PAGE_SIZE > 4096 bytes. > > > > Since f2fs is not supported on this systems (can't mount f2fs > > > > filesystem). > > > > > > Some spelling fixes and re-phrasing suggestion: > > > > > > > Don't run f2fs tests on systems with PAGE_SIZE > 4096 bytes since f2fs > > > > is not supported on these systems and mounting a f2fs filesystems fails. > > > > > > And: > > > > > > +PAGE_SIZE=$(getconf PAGE_SIZE) > > > +F2FS_BLKSIZE=4096 > > > +if [ $PAGE_SIZE > $F2FS_BLKSIZE ]; then > > > + printf "F2FS not supported on PAGE_SIZE(%d) != %d\n" $PAGE_SIZE > > > $F2FS_BLKSIZE > > > > > > I would write "f2fs" in lower case here for consistency with the rest > > > of the script. > > > > > > + exit 77 > > > +fi > > > > Adrian, > > > > thanks. Attached v2 patch. > > Any chance this could be merged ? Thanks. Sorry, somehow I have missed your patch. Next time please use "git send-email ..." to send new patch in new thread. Then it will be much easier to spot. I will put all variables expansions into quotes. Just in case. Otherwise Reviewed-by: Daniel Kiper Daniel ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
Re: 119 grub commands not documented in grub.texi
On Wed, Apr 22, 2020 at 09:29:13PM +0200, Hans Ulrich Niedermann wrote:
> On Wed, 22 Apr 2020 12:10:31 +0200
> Daniel Kiper wrote:
>
> > On Sat, Apr 18, 2020 at 12:53:12PM +0200, Hans Ulrich Niedermann
> > wrote:
> > > I have noticed that there are two commands documented in grub.texi
> > > which appear not to occur anywhere within the grub source code:
> > > 'pxe_unload' and 'uppermem'.
> > >
> > > @node pxe_unload
> > > @subsection pxe_unload
> > >
> > > @deffn Command pxe_unload
> > > Unload the PXE environment (@pxref{Network}).
> > >
> > > This command is only available on PC BIOS systems.
> > > @end deffn
> > >
> > > However, judging from the source code ("git grep pxe_unload"),
> > > pxe_unload is not available at all, so the documentation is wrong
> > > when it claims that the command were available on PC BIOS systems.
> > >
> > > Should 'pxe_unload' be removed from grub.texi, or does it need a
> > > notice that there are plans to implement it?
> >
> > If it is not implemented please drop it.
>
> I could not find any traces in the current source tree: The string
> pxe_unload only appears in ChangeLog-2015 and docs/grub.texi:
>
> $ git grep pxe_unload
> ChangeLog-2015: * include/grub/i386/pc/pxe.h (grub_pxe_unload): Removed.
> ChangeLog-2015: (pxe_unload): New section.
> ChangeLog-2015: (grub_cmd_pxe_unload): New function.
> docs/grub.texi:* pxe_unload:: Unload the PXE environment
> docs/grub.texi:@node pxe_unload
> docs/grub.texi:@subsection pxe_unload
> docs/grub.texi:@deffn Command pxe_unload
> $
>
> Looks like 671a78acb0648d3d73c95ab0f021f907499aacc0 from 2011-07-05
> removed the code. The removal of the 'pxe_unload' documentation will be
> in my patch set.
>
> > > Regarding 'uppermem', there is only
> > >
> > > @node uppermem
> > > @subsection uppermem
> > >
> > > This command is not yet implemented for GRUB 2, although it is
> > > planned.
> > >
> > > This may be a valid state for the "uppermem" command.
> >
> > Probably it is a remnant from ancient times. Please drop it too.
>
> I have found the (non-existing) 'uppermem' command mentioned in the
> 'GNU/Linux' node (info grub -n 'GNU/Linux') as well:
>
> | @strong{Caution:} If you use an initrd and specify the @samp{mem=}
> | option to the kernel to let it use less than actual memory size, you
> | will also have to specify the same memory size to GRUB. To let GRUB
> | know the size, run the command @command{uppermem} @emph{before}
> | loading the kernel. @xref{uppermem}, for more information.
>
> Maybe someone with some familiarity with the code which implements the
> "linux" and "initrd" commands and how Linux kernels and Linux
> initrds are loaded could shed some light on the current status of
> the 'mem=' Linux kernel parameter and the non-existing 'uppermem' grub
> command.
>
> Might this be the reason why 'uppermem' has been planned for Grub2 in
> the past?
It looks that it was planned. However, if nobody wrote it up until now
then nobody wants to use it. So, I think that we can safely drop it from
the documentation to not confuse the user.
> > > If you want me to, I can submit a patch for the check-commands.py
> >
> > I cannot find check-commands.py, anyway...
> >
> > > script to autogenerate a list of undocumented commands which should
> > > be documented which can then be auto-included in grub.texi and
> > > appear in the generated 'grub.info'. This would give a reader of
> > > the grub manual at least the knowledge that those command actually
> > > exist, and could be coupled with a call for help documenting those
> > > commands right inside grub.texi itself.
> >
> > That would be perfect. Especially if it appears in 2.06 release.
>
> That patch is on its way.
I saw it. However, I have to ask somebody more familiar with python than
I to make its review.
Daniel
___
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel
Re: [PATCH 2/3] docs: Remove docs for non-existing pxe_unload command
On Wed, Apr 22, 2020 at 09:32:41PM +0200, Hans Ulrich Niedermann wrote: > Remove the documentation for the pxe_unload command from > the docs/grub.texi file. > > The pxe_unload command is not implemented in the grub > source at all and appears to have been removed in commit > 71a78acb0648d3d73c95ab0f021f907499aacc0 (from 2011-07-05). > > Signed-off-by: Hans Ulrich Niedermann Reviewed-by: Daniel Kiper Daniel ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
Re: [PATCH] gitignore: Add a few forgotten files
On Wed, Apr 22, 2020 at 10:31:35PM +0200, Hans Ulrich Niedermann wrote: > On Wed, 22 Apr 2020 21:54:14 +0200 > John Paul Adrian Glaubitz wrote: > > > On 4/22/20 9:44 PM, Hans Ulrich Niedermann wrote: > > > Signed-off-by: Hans Ulrich Niedermann > > > --- > > > .gitignore | 3 +++ > > > 1 file changed, 3 insertions(+) > > > > > > diff --git a/.gitignore b/.gitignore > > > index 819cd185d..149b3713a 100644 > > > --- a/.gitignore > > > +++ b/.gitignore > > > @@ -3,6 +3,7 @@ > > > 10_* > > > 20_linux_xen > > > 30_os-prober > > > +/30_uefi-firmware > > > 40_custom > > > 41_custom > > > *.1 > > > @@ -18,6 +19,7 @@ build-grub-gen-asciih > > > build-grub-gen-widthspec > > > build-grub-mkfont > > > cdboot_test > > > +/ChangeLog > > > cmp_test > > > config.cache > > > config.guess > > > @@ -31,6 +33,7 @@ configure > > > core_compress_test > > > DISTLIST > > > docs/*.info > > > +/docs/*.info-* > > > docs/stamp-vti > > > docs/version.texi > > > ehci_test > > > > What's with the preceding slash in the filenames? Is it really > > "/30_uefi-firmware"? > > Yes. > > If a ".gitignore" file contains > > /ChangeLog > > then git will only ignore a file named "ChangeLog" located in the same > directory where the .gitignore file is, i.e. a file like > "subdir/ChangeLog" will not match. > > If a ".gitignore" file contains > > Makefile > > then git will ignore all files named Makefile located in the same > directory where the .gitignore file is _and_in_all_of_its_subdirs_. > > The files I want to ignore are created in just one specific > (sub)directory, so I want to ignore those files only in their > respective (sub)directory. Ignoring other files located in some other > directory just because they happen to have the same name does not make > sense and would be a mistake. > > Of course, this means it would make most sense to actually change most > lines in .gitignore to start with "/", but I just wanted to _add_ a few > forgotten files here without rewriting everything from scratch, but > without copying the mistakes of the existing lines to the newly added > lines. I have checked the .gitignore file and it looks like complete mess. So, if you touch this file I would like to ask you to do some cleanups. First of all group all entries with "/" and without it in separate groups (one empty line separator is OK; I think that entries with "/" should land in first group but I am not strongly tied to that). This should go into patch one. Then sort both groups alphabetically (second patch). And at the end add your entries into relevant groups (third patch or four one if you do next). If you could identify which currently existing entries have "/" missing and add it that would be perfect (third patch). And some more hints. If you post more than one patch please create cover letter (git send-email --compose ...). Please create new thread for new patchset and do not attach it to the existing threads. If you need to repost the patches please repost whole series as new thread instead of individual patches. Though I will review patches posted up until now. Daniel ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
Re: [PATCH] Don't run f2fs test on systems with PAGE_SIZE > 4KB
On Tue, Jul 30, 2019 at 3:10 PM Anatoly Pugachev wrote: > > On Tue, Jul 30, 2019 at 1:00 PM John Paul Adrian Glaubitz > wrote: > > On 7/30/19 10:11 AM, Anatoly Pugachev wrote: > > > don't run f2fs test on systems with PAGE_SIZE > 4096 bytes. > > > Since f2fs is not supported on this systems (can't mount f2fs filesystem). > > > > Some spelling fixes and re-phrasing suggestion: > > > > > Don't run f2fs tests on systems with PAGE_SIZE > 4096 bytes since f2fs > > > is not supported on these systems and mounting a f2fs filesystems fails. > > > > And: > > > > +PAGE_SIZE=$(getconf PAGE_SIZE) > > +F2FS_BLKSIZE=4096 > > +if [ $PAGE_SIZE > $F2FS_BLKSIZE ]; then > > + printf "F2FS not supported on PAGE_SIZE(%d) != %d\n" $PAGE_SIZE > > $F2FS_BLKSIZE > > > > I would write "f2fs" in lower case here for consistency with the rest of > > the script. > > > > + exit 77 > > +fi > > Adrian, > > thanks. Attached v2 patch. Any chance this could be merged ? Thanks. ___ Grub-devel mailing list Grub-devel@gnu.org https://lists.gnu.org/mailman/listinfo/grub-devel
