Next: , Previous: , Up: Creating boilerplate   [Index]

3.4 top: Add a top line to the boilerplate

Boilerplate can sometimes have an initial line that gives a short description of the file. The top command is used to specify that "top" line of the current working boilerplate:

$ licensing top "frcode.c: front-compress a sorted list"

Subsequent calls of the top command will override previous calls. The idea here is to iterate through each source file, and calling top before apply-ing the boilerplate.

Running the top command without any arguments displays the top line in the current working boilerplate:

$ licensing top
frcode.c: front-compress a sorted list

The --remove option will remove the top line from the current working boilerplate.

The --quiet option prevents the ‘Added.’ or ‘Removed.’ message from being displayed.