Skip to content

Commit

Permalink
Add description and update help text for amalgamate.py -d option
Browse files Browse the repository at this point in the history
  • Loading branch information
rmisev committed Aug 27, 2024
1 parent 3325fb5 commit 39bd2bd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion tools/amalgamate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Python v.2.7.0 or higher is required.
## Using amalgamate.py

amalgamate.py [-v] -c path/to/config.json -s path/to/source/dir \
[-p path/to/prologue.(c|h)]
[-p path/to/prologue.(c|h)] [-d]

* The `-c, --config` option should specify the path to a JSON config file which
lists the source files, include paths and where to write the resulting
Expand All @@ -64,3 +64,5 @@ Python v.2.7.0 or higher is required.
* The `-p, --prologue` option should specify the path to a file which will be
added to the beginning of the amalgamation. It is optional.

* The `-d, --no-duplicates` option instructs to comment out duplicate include
directives that are not expanded.
2 changes: 1 addition & 1 deletion tools/amalgamate/amalgamate.py
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ def main():
required=False, metavar="", help="path to a C prologue file")

argsparser.add_argument("-d", "--no-duplicates", dest="no_duplicates",
action='store_true', help="comment out the duplicate includes")
action='store_true', help="comment out duplicate include directives")

amalgamation = Amalgamation(argsparser.parse_args())
amalgamation.generate()
Expand Down

0 comments on commit 39bd2bd

Please sign in to comment.