Merge pull request #24 from thewtex/examples-markup

doc: Fix the examples markup
This commit is contained in:
Matt McCormick 2016-08-02 12:03:43 -04:00 committed by GitHub
commit c92fde55b8

View File

@ -194,13 +194,15 @@ Extra arguments to pass to the ``docker run`` command.
Examples Examples
-------- --------
1. **dockcross make**: Build the Makefile in the current directory. 1. ``dockcross make``: Build the *Makefile* in the current directory.
2. **dockcross cmake -Bbuild -H. -GNinja**: Run CMake with a build directory "build" for the CMakeLists.txt in the current directory and generate `ninja` files. 2. ``dockcross cmake -Bbuild -H. -GNinja``: Run CMake with a build directory
3. **dockcross ninja -Cbuild**: Run ninja in the generated build directory. ``./build`` for a *CMakeLists.txt* file in the current directory and generate
4. **dockcross bash -c '$CC test/C/hello.c -o hello'**: Build the hello.c file ``ninja`` build configuration files.
with the compiler identified with the `CC` environmental variable in the 3. ``dockcross ninja -Cbuild``: Run ninja in the ``./build`` directory.
4. ``dockcross bash -c '$CC test/C/hello.c -o hello'``: Build the *hello.c* file
with the compiler identified with the ``CC`` environmental variable in the
build environment. build environment.
5. **dockcross bash**: Run an interactive shell in the build environment. 5. ``dockcross bash``: Run an interactive shell in the build environment.
Note that commands are executed verbatim. If any shell processing for Note that commands are executed verbatim. If any shell processing for
environment variable expansion or redirection is required, please use environment variable expansion or redirection is required, please use