[MERGE] Bazaar User Reference

[James Westby]

On (06/08/07 20:48), Ian Clatworthy wrote:
> A patch to generate a "complete" User Reference from online help is
> attached. If you're only interested in seeing the end result rather than
> the code, a sample output can be found here:
> http://people.ubuntu.com/~ianc/doc/bzr_man.htm.

This looks good.

> -     Supported formats       Autodetected by extension
> -     -----------------       -------------------------
> +      =================       =========================
> +      Supported formats       Autodetected by extension
> +      =================       =========================
>           dir                            -

This leads to an artefact in the generated output above. Perhaps there
is another character that would go here, or perhaps "(none)" or similar.

> +_env_variables = \
> +"""Environment Variables
> +
> +:BZRPATH:         Path where bzr is to look for shell plugin external commands
> +:BZR_EMAIL:       E-Mail address of the user. Overrides default user config.

Overrides EMAIL.

> +:EMAIL:           E-Mail address of the user. Overrides default user config.
> +:BZR_EDITOR:      Editor for editing commit messages

Overrides EDITOR.

> +:EDITOR:          Editor for editing commit messages
> +:BZR_PLUGIN_PATH: Paths where bzr should look for plugins

This formats strangely in the posted output.

> +:BZR_HOME:        Home directory for bzr

Overrides HOME?

There is also inconsistency in ending the items with full-stops.

> -    return bzrdir.format_registry.help_topic(topic)
> +    return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)

This leads to incorrect formatting for the dirstate/default entry in the
posted output.

It would be great if the cross-references could be hyper-linked, but I
guess that might be tricky, it is not needed for this to be merged.

Thanks,

James

-- 
  James Westby   --    GPG Key ID: B577FE13    --     http://jameswestby.net/
  seccure key - (3+)k7|M*edCX/.A:n*N!>|&7U.L#9E)Tu)T0>AM - secp256r1/nistp256