Skip to content

Commit

Permalink
docs tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
Troy Straszheim committed Jan 8, 2012
1 parent 84fa615 commit 7b72d4e
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions doc/macros.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,13 @@ Convenience macros
``CMAKE_INSTALL_PREFIX``/etc/catkin/profile.d, where it will be
read by the installed ``setup.sh`` and friends.

**NOTE** These files share a single directory... be carefult to
give the file a unique name. Typically ``NNprojectname.sh`` is
used, where NN can define when something should be run (the files
are read in alphanumeric order) and ``projectname`` serves to
disambiguate in the event of collision.
.. note:: Note the extra ".in" that must appear in the filename
that does not appear in the argument.

**NOTE** These files will share a single directory with other
packages that choose to install env hooks. Be careful to give the
file a unique name. Typically ``NNprojectname.sh`` is used, where
NN can define when something should be run (the files are read in
alphanumeric order) and ``projectname`` serves to disambiguate in
the event of collision.

0 comments on commit 7b72d4e

Please sign in to comment.