[new port] usage of shar command

[Joe]

Chip Camden wrote:
> Quoth Joe on Monday, 19 July 2010:
>> Matthew Seaman wrote:
>>> On 18/07/2010 10:56:42, Joe wrote:
>>>
>>>> After getting my port ready for submitting to the ports system, I read
>>>> the above section from the porters handbook and come to a show stopper.
>>>>
>>>> I can not figure out just what the author was trying to say with
>>>> "output of shar `find port_dir`"
>>>>
>>>> Can someone explain how the shar command is intended to be used to
>>>> create the file that gets send with the [new port] pr?
>>> Suppose you have called your new port "splat", and you have therefore a
>>> directory ~/splat containing the port Makefile, distinfo, pkg-descr,
>>> etc.  Then what you need to do is run exactly this:
>>>
>>>    % cd ~
>>>    % shar `find splat` > splat.shar
>>>
>>> Note the special `backticks` -- they're important.
>>>
>>> What this does is --
>>>
>>>    * Runs the command: find splat
>>>      This will print out a list of all the file and directory names
>>>      under the directory splat.
>>>    * Takes that list and turns it into part of the command line for
>>>      shar.
>>>    * Runs shar over all the files and directories found by find.
>>>
>>> Now, just attach that  splat.shar file to the PR (send-pr -a splat.shar)
>>> as the final step in submitting your new port.
>>>
>>> 	Cheers,
>>>
>>> 	Matthew
>> This needs to be in the handbook. How is anybody going to know that the
>> `find port_dir` is suppose to be enclosed by [`backticks`]. I has to be 
>> said in words not just a printed example.
>>
> The handbook shows backticks, at least in my browser:
> 
> http://www.freebsd.org/doc/en/books/porters-handbook/porting-submitting.html
> 
And like I said, stating that in words calls it to the attention of the 
reader.