Helping upgrading Grub2's documentation

Helping upgrading Grub2's documentation

[Arbiel Perlacremaz]

I would be glad to help upgrade Grub2's documentation.

1) Where is the latest Grub manual ?
2) What procedure is to be used to update it ?
3) Is a complete list of commands available ?
4) Is there a tool to test the commands ?

Arbiel

Re: Helping upgrading Grub2's documentation

[Jordan Uggla]

On Wed, Mar 7, 2012 at 2:58 PM, Arbiel Perlacremaz
<arbiel.perlacremaz@gmail.com> wrote:
> I would be glad to help upgrade Grub2's documentation.

Firstly, thank you. Documentation is very important and any help you
can give will be greatly appreciated.

>
> 1) Where is the latest Grub manual ?

http://www.gnu.org/software/grub/manual/grub.html is an html version
of the manual and is generally kept fairly up to date. But the source
is a texinfo manual, http://www.gnu.org/software/texinfo/ , kept in
docs/grub.texi in the source tree. You can check out latest grub
source with "bzr branch
http://bzr.savannah.gnu.org/r/grub/trunk/grub/". You can also view the
file at http://bazaar.launchpad.net/~vcs-imports/grub/grub2-bzr/view/head:/docs/grub.texi
but since you plan to contribute you'll want to become familiar with
bazaar.

> 2) What procedure is to be used to update it ?

You edit docs/grub.texi and submit a patch to this mailing list (with
your changes to docs/grub.texi and a new entry in Changelog). If
you're not familiar with the process of writing/submitting patches
feel free to ask more. There is also a developers manual at
docs/grub-dev.texi; It's aimed more at those wishing to contribute
code, but some of it applies to contributing documentation as well.

> 3) Is a complete list of commands available ?

Are you asking about userland utilities like grub-install or
grub-script commands like configfile?

For grub-script commands there is a partial list in the current
manual: http://www.gnu.org/software/grub/manual/grub.html#Commands

You can get a "full" list by running "pager=1; help" from the grub
shell. This is obviously not ideal, and will only include commands
available for the platform you're using, for instance grub-pc won't
include the "appleloader" command. Hopefully someone else can give you
a better list.

> 4) Is there a tool to test the commands ?

I'm not sure exactly what you mean. "make check" does do automated
testing, but not all commands are tested in "make check".

>
> Arbiel
>
> _______________________________________________
> Grub-devel mailing list
> Grub-devel@gnu.org
> https://lists.gnu.org/mailman/listinfo/grub-devel

It might also be useful to pop into the #grub IRC channel on freenode,
http://webchat.freenode.net/?channels=grub&uio=d4

-- 
Jordan Uggla (Jordan_U on irc.freenode.net)

Re: Helping upgrading Grub2's documentation

[Vladimir 'φ-coder/phcoder' Serbinenko]

[-- Attachment #1.1: Type: text/plain, Size: 405 bytes --]

On 08.03.2012 10:19, Jordan Uggla wrote:
> You can get a "full" list by running "pager=1; help" from the grub
> shell. This is obviously not ideal, and will only include commands
> available for the platform you're using, for instance grub-pc won't
> include the "appleloader" command. Hopefully someone else can give you
> a better list.


-- 
Regards
Vladimir 'φ-coder/phcoder' Serbinenko


[-- Attachment #1.2: cmdlist.txt --]
[-- Type: text/plain, Size: 1870 bytes --]

.
[
915resolution
acpi
appleloader
authenticate
background_color
background_image
backtrace
badram
blocklist
boot
break
cacheinfo
cat
chainloader
clear
cmosclean
cmostest
cmp
configfile
continue
cpuid
crc
cryptomount
cutmem
date
drivemap
dump
echo
efiemu_loadcore
efiemu_prepare
efiemu_unload
exit
export
extract_entries_configfile
extract_entries_source
extract_legacy_entries_configfile
extract_legacy_entries_source
fakebios
false
fix_video
fpswa
freedos
functional_test
gdbstub
gdbstub_break
gdbstub_stop
gptsync
halt
hashsum
hdparm
hello
help
hexdump
inb
initrd
initrd16
inl
insmod
inw
jpegtest
keymap
keystatus
kfreebsd
kfreebsd_loadenv
kfreebsd_module
kfreebsd_module_elf
knetbsd
knetbsd_module
knetbsd_module_elf
kopenbsd
kopenbsd_ramdisk
legacy_check_password
legacy_configfile
legacy_initrd
legacy_initrd_nounzip
legacy_kernel
legacy_password
legacy_source
linux
linux16
list_env
loadbios
load_env
loadfont
loopback
ls
lsacpi
lsapm
lsdev
lsefimmap
lsefisystab
lsfonts
lsmmap
lsmod
lspci
lssal
lsspd
lua
md5sum
menuentry
module
module2
multiboot
multiboot2
net_add_addr
net_add_dns
net_add_route
net_bootp
net_del_addr
net_del_dns
net_del_route
net_get_dhcp_option
net_ipv6_autoconf
net_ls_addr
net_ls_cards
net_ls_dns
net_ls_routes
net_nslookup
normal
normal_exit
ntldr
outb
outl
outw
parttool
password
password_pbkdf2
password_scrypt
plan9
play
pngtest
probe
pxechainloader
read
read_byte
read_dword
read_word
reboot
regexp
return
rmmod
save_env
search
sendkey
serial
set
setparams
setpci
sha1sum
sha256sum
sha512sum
shift
sleep
source
submenu
suspend
terminal_input
terminal_output
terminfo
test
test_blockarg
testload
tgatest
time
true
unset
usb
vbeinfo
vbetest
videoinfo
videotest
write_byte
write_dword
write_word
xnu_devprop_load
xnu_kernel
xnu_kernel64
xnu_kext
xnu_kextdir
xnu_mkext
xnu_ramdisk
xnu_resume
xnu_splash
xnu_uuid
zfs-bootfs
zfsinfo
zfskey

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 294 bytes --]