From 39ea3597690e1ece9e0d1f23e8ff200674e2a406 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Fri, 7 Dec 2018 14:15:19 +0200 Subject: Minor install/upgrade documentation improvements --- doc/cli.sh | 2 +- doc/install.cli | 21 ++++++++++++--------- 2 files changed, 13 insertions(+), 10 deletions(-) (limited to 'doc') diff --git a/doc/cli.sh b/doc/cli.sh index 05faa4d..316e14b 100755 --- a/doc/cli.sh +++ b/doc/cli.sh @@ -61,7 +61,7 @@ gen install --html-heading-map 2=h2 # function gen_txt () # { - cli --generate-txt --omit-link-check --link-regex '%#(.*)%\1 file%' \ + cli --generate-txt --omit-link-check --link-regex '%#(.*)%\U\1\E file%' \ -o .. --txt-suffix "" ../$1.cli } diff --git a/doc/install.cli b/doc/install.cli index ec14af1..b84ddf3 100644 --- a/doc/install.cli +++ b/doc/install.cli @@ -14,8 +14,8 @@ " \h0#preface|Preface| -The recommended way to install the \c{build2} toolchain in most circumstances -is using the automated install scripts as described on the +The recommended way to install and upgrade the \c{build2} toolchain in most +circumstances is using the automated install scripts as described on the \l{https://build2.org/install.xhtml Install} page. This document describes the manual installation and upgrade process which offers greater control can be helpful in situations where the automated scripts cannot be used (offline @@ -23,37 +23,40 @@ installation, packaging for system package managers, unsupported platform/compiler, etc). " +// NOTE: The following ids must correspond to the file names (used in +// plain-text links). + " -\h#INSTALL|Introduction| +\h#install|Introduction| " source "../INSTALL.cli"; " -\h#BOOTSTRAP-WINDOWS|Bootstrapping on Windows| +\h#bootstrap-windows|Bootstrapping on Windows| " source "../BOOTSTRAP-WINDOWS.cli"; " -\h2#BOOTSTRAP-MSVC|Bootstrapping with MSVC| +\h2#bootstrap-msvc|Bootstrapping with MSVC| " source "../BOOTSTRAP-MSVC.cli"; " -\h2#BOOTSTRAP-MINGW|Bootstrapping with MinGW| +\h2#bootstrap-mingw|Bootstrapping with MinGW| " source "../BOOTSTRAP-MINGW.cli"; " -\h#BOOTSTRAP-MACOSX|Bootstrapping on Mac OS X| +\h#bootstrap-macosx|Bootstrapping on Mac OS X| " source "../BOOTSTRAP-MACOSX.cli"; " -\h#BOOTSTRAP-UNIX|Bootstrapping on UNIX| +\h#bootstrap-unix|Bootstrapping on UNIX| " source "../BOOTSTRAP-UNIX.cli"; " -\h#UPGRADE|Upgrading| +\h#upgrade|Upgrading| " source "../UPGRADE.cli"; -- cgit v1.1