Skip to content

Commit

Permalink
Merge pull request #19 from tee3/feature/documentation-cleanup
Browse files Browse the repository at this point in the history
Clean up some documentation.
  • Loading branch information
tee3 authored Jun 23, 2019
2 parents 2396ea2 + 4d1e887 commit 16fbcd1
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ To show the options, run the following commands.

::

$ commands_to_compilation_database_py --help
commands_to_compilation_database_py --help

::

$ commands_to_compilation_database_cpp --help
commands_to_compilation_database_cpp --help

The simplest usage is to pipe the output from the compilation to the
program. The following command shows the usage with Boost.Build by
Expand All @@ -70,15 +70,15 @@ forcing the tool to generate all targets and dry-running the build

::

$ b2 -a -n | commands_to_compilation_database_py --build-tool=Boost.Build
b2 -a -n | commands_to_compilation_database_py --build-tool=Boost.Build

If the build tool provides a mechanism to output the compilation
commands while running, the compilation database can be updated
incrementally on each build as shown below for Boost.Build.

::

$ b2 -d+2 | tee | commands_to_compilation_database_py --build-tool=Boost.Build --incremental
b2 -d+2 | tee | commands_to_compilation_database_py --build-tool=Boost.Build --incremental

files_to_compilation_database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -87,19 +87,19 @@ To show the options, run the following commands.

::

$ files_to_compilation_database_py --help
files_to_compilation_database_py --help

::

$ files_to_compilation_database_cpp --help
files_to_compilation_database_cpp --help

The simplest usage is to pipe a list of filenames to the program. The
following command shows the usage with Git to generate the list of C
and C++ source and header filenames.

::

$ git ls-files *.[ch] *.[ch]pp | \
git ls-files *.[ch] *.[ch]pp | \
files_to_compilation_database_py \
--cflags="-std=c89" \
--cxxflags="-std=c++11" \
Expand All @@ -119,13 +119,13 @@ C++ Implementation

- Standard C++11 Compiler

- auto
- std::begin, std::end
- ``auto``
- ``std::begin``, ``std::end``
- etc.

- Standard C++11 Standard Library

- <regex>
- ``<regex>``

- Boost C++ Libraries 1.55.0

Expand All @@ -142,7 +142,7 @@ Run the following command to build and test the system.

::

$ b2
b2

Installation
------------
Expand All @@ -152,4 +152,4 @@ prefix.

::

$ b2 --prefix=/usr/local install
b2 --prefix=/usr/local install

0 comments on commit 16fbcd1

Please sign in to comment.