@@ -37,7 +37,7 @@ docker build --build-arg BASE_TAG=base/bullseye --build-arg GIT_TAG=[...] -f etc
3737```
3838
3939This will use ` base/bullseye ` as a base to build the SDK version provided in ` GIT_TAG ` ,
40- which should be a tagged release version. The SDK will be cloned from
40+ which should be a tagged release version. The SDK will be cloned from
4141https://github.com/viamrobotics/viam-cpp-sdk/ . This is the recommended approach for
4242C++ module development, which should generally be done against a tagged release.
4343
@@ -47,22 +47,22 @@ docker build --build-arg BASE_TAG=base/bullseye --build-arg REPO_SETUP=copy -f e
4747```
4848
4949Note the use of the build argument ` REPO_SETUP=copy ` , which adds a Docker instruction
50- to copy the SDK repo from the current working directory, rather than cloning from
50+ to copy the SDK repo from the current working directory, rather than cloning from
5151GitHub. This approach may make more sense for developing on the SDK itself, or if
5252your C++ SDK development relies on a localversion of the SDK.
5353
5454The examples above illustrated the use of several ` --build-arg ` arguments, namely
55- ` BASE_TAG ` , ` GIT_TAG ` , and ` REPO_SETUP ` . Please see
55+ ` BASE_TAG ` , ` GIT_TAG ` , and ` REPO_SETUP ` . Please see
5656[ Dockerfile.sdk-build] ( etc/docker/Dockerfile.sdk-build ) for a complete account of
5757all build arguments and their defaults.
5858
5959## Building Documentation Locally for Testing
6060The C++ sdk uses [ Doxygen] ( https://www.doxygen.nl/ ) to generate documentation.
6161An automated workflow will generate and update our documentation on each merge,
62- and publish it to [ cpp.viam.dev] ( https://cpp.viam.dev ) .
62+ and publish it to [ cpp.viam.dev] ( https://cpp.viam.dev ) .
6363
6464Generating documentation locally to observe changes while developing with the
65- C++ SDK is simple.
65+ C++ SDK is simple.
6666First, make sure doxygen is installed, e.g.,
6767```
6868(on mac) brew install doxygen
@@ -91,10 +91,10 @@ quickly as possible.
9191## A note on logging
9292
9393Users should only interact with logging via the macros, classes, and functions in
94- [ ` viam/sdk/log/logging.hpp ` ] ( src/viam/sdk/log/logging.hpp ) . Logging is
94+ [ ` viam/sdk/log/logging.hpp ` ] ( src/viam/sdk/log/logging.hpp ) . Logging is
9595implemented using Boost.Log, but this is an implementation detail subject
9696to change without warning. In particular, using Boost.Log macros such as
97- ` BOOST_LOG_TRIVIAL ` or ` BOOST_LOG_SEV ` is undefined behavior which will likely
97+ ` BOOST_LOG_TRIVIAL ` or ` BOOST_LOG_SEV ` is undefined behavior which will likely
9898fail to output log messages.
9999
100100## License
0 commit comments