diff options
author | Enrico Joerns <e.joerns@tu-bs.de> | 2015-06-02 17:29:46 +0200 |
---|---|---|
committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2015-12-03 22:37:00 +0100 |
commit | f01119b7b44d371bfb51291314ef4357327d3423 (patch) | |
tree | 1fb9cb2f938fd7a9ddbd28ca3ad9af5060191190 /doc | |
parent | 679ebd4804c9ac558e9fdae4a4fe32b4ac826a66 (diff) | |
download | ptxdist-f01119b7b44d371bfb51291314ef4357327d3423.tar.gz ptxdist-f01119b7b44d371bfb51291314ef4357327d3423.tar.xz |
doc: remove escaping in code sections
Signed-off-by: Enrico Joerns <e.joerns@tu-bs.de>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/dev_manual.rst | 12 | ||||
-rw-r--r-- | doc/environment.rst | 22 | ||||
-rw-r--r-- | doc/user_manual.rst | 34 |
3 files changed, 34 insertions, 34 deletions
diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst index 1305174c1..78b49a3b4 100644 --- a/doc/dev_manual.rst +++ b/doc/dev_manual.rst @@ -222,7 +222,7 @@ directory first. Then we run :: - $ ptxdist newpackage |\textless{}package type\textgreater{}| + $ ptxdist newpackage <package type> If we omit the <``package type``\ >, PTXdist will list all available package types. @@ -430,15 +430,15 @@ file and we can simply run: [...] checking build system type... i686-host-linux-gnu - checking host system type... |\ptxdistCompilerName{}| + checking host system type... <ptxdistCompilerName> checking whether to enable maintainer-specific portions of Makefiles... no checking for a BSD-compatible install... /usr/bin/install -c checking whether build environment is sane... yes checking for a thread-safe mkdir -p... /bin/mkdir -p checking for gawk... gawk checking whether make sets $(MAKE)... yes - checking for |\ptxdistCompilerName{}|-strip... |\ptxdistCompilerName{}|-strip - checking for |\ptxdistCompilerName{}|-gcc... |\ptxdistCompilerName{}|-gcc + checking for <ptxdistCompilerName>-strip... <ptxdistCompilerName>-strip + checking for <ptxdistCompilerName>-gcc... <ptxdistCompilerName>-gcc checking for C compiler default output file name... a.out [...] @@ -649,7 +649,7 @@ available: :: - rules/ @\$@ find . -name \*.in | xargs grep "## SECTION" + rules/ $ find . -name \*.in | xargs grep "## SECTION" ./acpid.in:## SECTION=shell_and_console ./alsa-lib.in:## SECTION=system_libraries ./alsa-utils.in:## SECTION=multimedia_sound @@ -736,7 +736,7 @@ To do a fast check if this addition was successful, we run: :: $ ptxdist print FOO_AUTOCONF - --prefix=/usr --sysconfdir=/etc --host=|\ptxdistCompilerName{}| --build=i686-host-linux-gnu --enable-debug --with-bar + --prefix=/usr --sysconfdir=/etc --host=<ptxdistCompilerName> --build=i686-host-linux-gnu --enable-debug --with-bar Note: It depends on the currently selected platform and its architecture what content this variable will have. The content shown above is an diff --git a/doc/environment.rst b/doc/environment.rst index 5d51a2de7..280f036b7 100644 --- a/doc/environment.rst +++ b/doc/environment.rst @@ -139,14 +139,14 @@ Next step is to extract the archive: :: - $ tar -xjf ptxdist-|\verbatimcmd\ptxdistVendorVersion{}|.tar.bz2 + $ tar -xjf ptxdist-\verbatimcmd\ptxdistVendorVersion{}.tar.bz2 If everything goes well, we now have a PTXdist- directory, so we can change into it: :: - $ cd ptxdist-|\verbatimcmd\ptxdistVendorVersion| + $ cd ptxdist-\verbatimcmd\ptxdistVendorVersion $ ls -lF total 530 -rw-r--r-- 1 jb user 18446 Sep 9 15:59 COPYING @@ -418,7 +418,7 @@ If we want to check if our toolchain was built with the :: - $ mytoolchain-gcc -v 2|\textgreater{}\&|1 | grep with-sysroot + $ mytoolchain-gcc -v 2\textgreater{}\&1 | grep with-sysroot If this command **does not** output anything, this toolchain was not built with the ``--with-sysroot`` option and cannot be used with @@ -485,7 +485,7 @@ the board support package: :: - $ apt-get install oselas.toolchain-|\oselasTCNVendorVersion \oselasTCNVendorPatchLevel -\ptxdistCompilerName-\ptxdistCompilerVersion| + $ apt-get install oselas.toolchain-\oselasTCNVendorVersion \oselasTCNVendorPatchLevel -\ptxdistCompilerName-<ptxdistCompilerVersion> These package names are very long and hard to type without making typos. An easier way is to ask the package manager for available toolchains and @@ -493,8 +493,8 @@ just use the name by copy and paste it. :: - $ apt-cache search "oselas.toolchain-.*-|\oselasTCNarch|.*|\oselasTCNvariant|.*" - oselas.toolchain-|\oselasTCNVendorVersion \oselasTCNVendorPatchLevel -\ptxdistCompilerName-\ptxdistCompilerVersion| + $ apt-cache search "oselas.toolchain-.*-\oselasTCNarch.*\oselasTCNvariant.*" + oselas.toolchain-\oselasTCNVendorVersion \oselasTCNVendorPatchLevel -\ptxdistCompilerName-<ptxdistCompilerVersion> The binary OSELAS Toolchain Package for non-Debian Distributions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -621,11 +621,11 @@ directory’ as a component. If yes, remove it first. :: - $ tar xf OSELAS.Toolchain-|\verbatimcmd\oselasTCNVendorVersion{}\oselasTCNVendorPatchLevel|.tar.bz2 - $ cd OSELAS.Toolchain-|\verbatimcmd\oselasTCNVendorVersion{}\oselasTCNVendorPatchLevel| - $ ^ptxdist-|\oselasTCNVendorptxdistversion{}| select ptxconfigs/|\verbatimcmd\ptxcr| - |\verbatimcmd\oselasToolchainName|.ptxconfig^ - $ ptxdist-|\oselasTCNVendorptxdistversion{}| go + $ tar xf OSELAS.Toolchain-\verbatimcmd\oselasTCNVendorVersion{}\oselasTCNVendorPatchLevel.tar.bz2 + $ cd OSELAS.Toolchain-\verbatimcmd\oselasTCNVendorVersion{}\oselasTCNVendorPatchLevel + $ ptxdist-\oselasTCNVendorptxdistversion{} select ptxconfigs/\verbatimcmd\ptxcr + \verbatimcmd\oselasToolchainName.ptxconfig + $ ptxdist-\oselasTCNVendorptxdistversion{} go At this stage we have to go to our boss and tell him that it’s probably time to go home for the day. Even on reasonably fast machines the time diff --git a/doc/user_manual.rst b/doc/user_manual.rst index ac92bd1bc..f953a78d4 100644 --- a/doc/user_manual.rst +++ b/doc/user_manual.rst @@ -140,7 +140,7 @@ command: :: - $ ptxdist |\textless{}parameter\textgreater{}| + $ ptxdist <parameter> To run different functions, this command must be extended by parameters to define the function we want to run. @@ -255,8 +255,8 @@ archive first. :: - $ tar -zxf |\verbatimcmd\ptxdistBSPName|.tar.gz - $ cd |\verbatimcmd\ptxdistBSPName| + $ tar -zxf <ptxdistBSPName>.tar.gz + $ cd <ptxdistBSPName> PTXdist is project centric, so now after changing into the new directory we have access to all valid components. @@ -348,7 +348,7 @@ following step: $ ptxdist select configs/ptxconfig info: selected ptxconfig: - |\hspace*{1cm}|'configs/ptxconfig' + 'configs/ptxconfig' Selecting a Hardware Platform ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -358,9 +358,9 @@ platforms to build for. In this case we want to build for the : :: - $ ptxdist platform configs/|\verbatimcmd\ptxdistPlatformName|/platformconfig|\verbatimcmd\ptxdistPlatformVariant| + $ ptxdist platform configs/<ptxdistPlatformName>/platformconfig<ptxdistPlatformVariant> info: selected platformconfig: - |\hspace*{1cm}| 'configs/|\ptxdistPlatformName|/platformconfig|\ptxdistPlatformVariant|' + 'configs/<ptxdistPlatformName>/platformconfig<ptxdistPlatformVariant>' Note: If you have installed the OSELAS.Toolchain() at its default location, PTXdist should already have detected the proper toolchain @@ -369,8 +369,8 @@ while selecting the platform. In this case it will output: :: found and using toolchain: - '/opt/OSELAS.Toolchain-|\oselasTCNVendorVersion \oselasTCNVendorPatchLevel|/|\ptxdistCompilerName|/|\ptxcr| - |\hspace{20pt}\ptxdistCompilerVersion|/bin' + '/opt/OSELAS.Toolchain-<oselasTCNVendorVersion><oselasTCNVendorPatchLevel>/<ptxdistCompilerName>/<ptxcr> + <ptxdistCompilerVersion>/bin' If it fails you can continue to select the toolchain manually as mentioned in the next section. If this autodetection was successful, we @@ -387,9 +387,9 @@ To reduce the package count for the run: :: - $ ptxdist collection configs/|\verbatimcmd\ptxdistPlatformCollection| + $ ptxdist collection configs/<ptxdistPlatformCollection> info: selected collectionconfig: - |\hspace*{1cm}|'configs/|\ptxdistPlatformCollection|' + 'configs/<ptxdistPlatformCollection>' Selecting a Toolchain ~~~~~~~~~~~~~~~~~~~~~ @@ -400,8 +400,8 @@ for the target. :: - $ ^ptxdist toolchain /opt/OSELAS.Toolchain-|\verbatimcmd\oselasTCNVendorVersion \oselasTCNVendorPatchLevel|/|\verbatimcmd\ptxdistCompilerName|/|\verbatimcmd\ptxcr| - |\hspace*{1cm}\verbatimcmd\ptxdistCompilerVersion|/bin + $ ptxdist toolchain /opt/OSELAS.Toolchain-\oselasTCNVendorVersion \oselasTCNVendorPatchLevel/<ptxdistCompilerName>/\ptxcr + <ptxdistCompilerVersion>/bin Building the Root Filesystem Content ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -523,7 +523,7 @@ Simply run :: - |\$ ./configs/\ptxdistPlatformName{}/run| + $ ./configs/<ptxdistPlatformName>/run This will start QEMU in full system emulation mode and runs the previously built kernel which then uses the generated disk image to @@ -701,7 +701,7 @@ In this Kconfig dialogue we navigate to the entry: :: Linux kernel ---> - (|\ptxdistPlatformKernelRev{}|) kernel version + (\ptxdistPlatformKernelRev{}) kernel version and replace the 3.0 value by the 3.7 value. @@ -788,7 +788,7 @@ hard disk image must be re-created with: :: $ ptxdist images - |\$ ./configs/\ptxdistPlatformName/run| + $ ./configs/\ptxdistPlatformName/run The emulated system should now start with a 3.7 based kernel with USB support. @@ -810,7 +810,7 @@ our target’s shell. Assuming we forgot to enable this command, we get: :: - |\$ ./configs/\ptxdistPlatformName/run| + $ ./configs/\ptxdistPlatformName/run ptx login: root login[xxx]: root login on 'ttyS0' @@ -851,7 +851,7 @@ us test the new command: :: $ ptxdist images - |\$ ./configs/\ptxdistPlatformName/run| + $ ./configs/\ptxdistPlatformName/run Log in on the emulated system and simply check with a: |