grub-mkimage and other utils documentation

grub-mkimage and other utils documentation

[Andrey Borzenkov]

I started to clean --pubkey in docs, hit grub-mkimage reference, hit
"grub-install is just a shell script" ... it really needs cleanup. Is
grub-install terse description intentional? If not, I'm going to
actually document all utilities and all options not defined as hidden.
We probably need to mention common options between various utilities
as well.

Or should some tools be skipped? I'm fine to document them in
grub-devel though, but I'd like to have them documented /somewhere/.

Re: grub-mkimage and other utils documentation

[Jonathan McCune]

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

On Tue, Nov 26, 2013 at 8:40 AM, Andrey Borzenkov <arvidjaar@gmail.com>wrote:

> I started to clean --pubkey in docs, hit grub-mkimage reference, hit
> "grub-install is just a shell script" ... it really needs cleanup.


I think the grub-mkimage reference can be dropped now that the native-code
grub-install is in place and supports --pubkey itself.  Sorry, at the time
those were written it was hard not to reveal some internals.  Thanks for
taking the initiative to clean them up.

-Jon



> Is
> grub-install terse description intentional? If not, I'm going to
> actually document all utilities and all options not defined as hidden.
> We probably need to mention common options between various utilities
> as well.
>
> Or should some tools be skipped? I'm fine to document them in
> grub-devel though, but I'd like to have them documented /somewhere/.
>
> _______________________________________________
> Grub-devel mailing list
> Grub-devel@gnu.org
> https://lists.gnu.org/mailman/listinfo/grub-devel
>

[-- Attachment #2: Type: text/html, Size: 1675 bytes --]

Re: grub-mkimage and other utils documentation

[Bruce Dubbs]

Andrey Borzenkov wrote:
> I started to clean --pubkey in docs, hit grub-mkimage reference, hit
> "grub-install is just a shell script" ... it really needs cleanup. Is
> grub-install terse description intentional? If not, I'm going to
> actually document all utilities and all options not defined as hidden.
> We probably need to mention common options between various utilities
> as well.
>
> Or should some tools be skipped? I'm fine to document them in
> grub-devel though, but I'd like to have them documented /somewhere/.

Things that can be run by a user or admin should be in the main 
documentation.  Those things run by a developer for 
building/testing/debugging, etc should be in grub-devel.

I'd put any program that is installed in the file system
/{,usr/}{,s}bin  directories in the category of admin.

   -- Bruce

Re: grub-mkimage and other utils documentation

[Andrey Borzenkov]

В Tue, 26 Nov 2013 09:02:09 -0800
Jonathan McCune <jonmccune@google.com> пишет:

> On Tue, Nov 26, 2013 at 8:40 AM, Andrey Borzenkov <arvidjaar@gmail.com>wrote:
> 
> > I started to clean --pubkey in docs, hit grub-mkimage reference, hit
> > "grub-install is just a shell script" ... it really needs cleanup.
> 
> 
> I think the grub-mkimage reference can be dropped now that the native-code
> grub-install is in place and supports --pubkey itself.

It is far more than --pubkey. grub-install section itself starts with
reference to grub-mkimage.

>                                                       Sorry, at the time
> those were written it was hard not to reveal some internals.  Thanks for
> taking the initiative to clean them up.
> 
> -Jon
> 
> 
> 
> > Is
> > grub-install terse description intentional? If not, I'm going to
> > actually document all utilities and all options not defined as hidden.
> > We probably need to mention common options between various utilities
> > as well.
> >
> > Or should some tools be skipped? I'm fine to document them in
> > grub-devel though, but I'd like to have them documented /somewhere/.
> >
> > _______________________________________________
> > Grub-devel mailing list
> > Grub-devel@gnu.org
> > https://lists.gnu.org/mailman/listinfo/grub-devel
> >

Re: grub-mkimage and other utils documentation

[Vladimir 'phcoder' Serbinenko]

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

Main user tools are install mknetdir mkrescue mkstandalone editenv mkconfig
mkfont mklayout. Skip setup it's useful to have around for devs but has no
interface stability and generally better be left alone.
Thank you very much for taking care of this
On Nov 26, 2013 5:41 PM, "Andrey Borzenkov" <arvidjaar@gmail.com> wrote:

> I started to clean --pubkey in docs, hit grub-mkimage reference, hit
> "grub-install is just a shell script" ... it really needs cleanup. Is
> grub-install terse description intentional? If not, I'm going to
> actually document all utilities and all options not defined as hidden.
> We probably need to mention common options between various utilities
> as well.
>
> Or should some tools be skipped? I'm fine to document them in
> grub-devel though, but I'd like to have them documented /somewhere/.
>
> _______________________________________________
> Grub-devel mailing list
> Grub-devel@gnu.org
> https://lists.gnu.org/mailman/listinfo/grub-devel
>

[-- Attachment #2: Type: text/html, Size: 1410 bytes --]