puppet.git - Puppet repo

	Commit message (Collapse)	Author	Age	Files	Lines
*	(#7764, 7775, 7778) Revisions to Faces help text	nfagerlund	2011-06-07	1	-19/+17
\| \| \| \| \| \| \| \| \| \| \| \| \| \|	Per UX review of help text, this commit makes several changes over the breadth of the Faces help: * Preface API-only action summaries/descriptions with "API only." (issue #7775) * Provide both CLI and API info in "returns," with the CLI info first. (issue #7778) * Summaries should be sentences. (Add punctuation.) * First sentences of descriptions should reiterate summaries. (Summaries and descriptions should be displayed far enough apart that this isn't a problem.) * Standardize on "subcommand" instead of "face" when talking about the entity you invoke at the command line. (Use "face" when describing API use.) * Fix outdated or clunky text in several faces.
*	(#7683) Use ronn, when available, to render the output.	Daniel Pittman	2011-06-01	1	-0/+48
\| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \|	We now look for ronn(1), and if it is available ask it to generate the *roff output, delegate that to man(1) directly, and show the result to the user in their pager. If ronn(1) isn't available we delegate to $MANPAGER, $PAGER, less, most, or more, in that order, to paginate the raw markdown. Not nearly so nice, but better than doing nothing. Finally, if none of those pagers are available we fall through to the default behaviour of puppet rendering the output, which more or less results in a direct dump to the console. Nice. Reviewed-By: Nick Fagerlund <nick.fagerlund@puppetlabs.com>
*	(#7683) Add a 'man' face and subcommand to Puppet.	Daniel Pittman	2011-06-01	1	-0/+47
	This is the minimal wrapper, cloning a good deal of the logic from help, that runs our face through the 'man' template and returns ronn-formatted Markdown. This provides the crudest baseline possible for getting man-style output, but lets us move forward to improve behaviour. Reviewed-By: Nick Fagerlund <nick.fagerlund@puppetlabs.com>