Skip to content

Commit

Permalink
Add instructions for batch file updates
Browse files Browse the repository at this point in the history
The key is the recently-added flag `--no-top-level-comment` or `--no-tlc` which
avoids adding the "TODO" comments to many files, thus not requiring manual
cleanup afterwards.
  • Loading branch information
mbrukman committed May 28, 2017
1 parent 304749d commit 80e6778
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,22 @@ Modify an existing file in-place:
autogen -i [...other params as above...]
```

Bulk update many existing files in-place:

```bash
find . -type f -name \*.sh -exec autogen -i --no-top-level-comment [options...] {} \;
```

The flag `--no-top-level-comment` avoids adding a comment such as:

```css
/* TODO: High-level file comment */
```

because either some or all of the files have such a top-level comment, or if
they don't, you probably wouldn't want to have to manually add or delete at this
time, if you're just trying to add the license header in bulk.

To get a list of supported licenses, or to see the full set of flags, run
`autogen` with no parameters.

Expand Down

0 comments on commit 80e6778

Please sign in to comment.