[PATCH v3 03/14] doc: mkimage: Reformat examples

Simon Glass sjg at chromium.org
Thu Jun 30 12:06:09 CEST 2022


On Sat, 25 Jun 2022 at 11:12, Sean Anderson <seanga2 at gmail.com> wrote:
>
> This puts each example in a new paragraph and uses a hanging indent for
> continued lines to increase clarity. We use tabs instead of .in or .RS for
> the indent because it renders properly in both man and mandoc (which is
> what many common HTML man pages use). The only nit is that the tab stops in
> man default to something like 2", so reduce that to 1". We also escape
> every "minus" as recommended by man-pages(7).
>
> Signed-off-by: Sean Anderson <seanga2 at gmail.com>
> ---
>
> (no changes since v2)
>
> Changes in v2:
> - Escape minus signs in examples
> - Indent things more robustly
>
>  doc/mkimage.1 | 116 +++++++++++++++++++++++++++++---------------------
>  1 file changed, 67 insertions(+), 49 deletions(-)

Reviewed-by: Simon Glass <sjg at chromium.org>

Gosh this format is a pain


More information about the U-Boot mailing list