[Intel-gfx] [maintainer-tools PATCH] dim.rst: Document aliases extension on dimrc.

[Jani Nikula]

On Thu, 17 Aug 2017, Rodrigo Vivi <rodrigo.vivi at intel.com> wrote:
> On my own workflow I was missing a way to download mboxes
> directly from patchwork with the patchwork id. So my first
> reflex was to modify dim to fulfil my needs. However that
> was increasing dim in complexity and dependencies and leaving
> that messy.
>
> That was when Jani suggested me the dimrc extension with the
> example that is now part of this spec.
>
> That was clean and simple enough to understand, so Daniel
> suggested me to add it to the spec.
>
> For record let's put my final local solution that lays now on
> my own ~/.dimrc
>
> dim_pwaq()
> {
> 	if [ -n "$1" ]; then
> 		curl https://patchwork.freedesktop.org/patch/$1/mbox/ | dim_apply_queued
> 	else
> 	echo "Give me a patchwork id"
> 	fi
> }
>
> Cc: Jani Nikula <jani.nikula at intel.com>
> Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
> Signed-off-by: Rodrigo Vivi <rodrigo.vivi at intel.com>
> ---
>  dim.rst | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>
> diff --git a/dim.rst b/dim.rst
> index 802c776e03f9..c6728d186554 100644
> --- a/dim.rst
> +++ b/dim.rst
> @@ -441,6 +441,22 @@ usage
>  Short form usage help listing all subcommands. Run by default or if an unknown
>  subcommand was passed on the cmdline.
>  
> +ALIASES
> +=======
> +
> +Extending **dim** functionalities
> +---------------------------------
> +
> +It is possible to create your own dim helper and aliases by adding them to \$HOME/.dimrc
> +
> +dim_my_fancy_list_aliases()
> +{
> +	echo "Hello world!"
> +	dim_list_aliases
> +}
> +
> +dim_alias_list_aliases=my-fancy-list-aliases
> +

Naughty, naughty:

$ make check
shellcheck -e SC2001 -e SC2034 -e SC2046 -e SC2086 -e SC2115 -e SC2119 -e SC2120 -e SC2143 dim bash_completion
rst2man --strict --no-raw dim.rst >/dev/null
dim.rst:453: (INFO/1) Possible title underline, too short for the title.
Treating it as ordinary text because it's so short.
Exiting due to level-1 (INFO) system message.
Makefile:49: recipe for target 'mancheck' failed
make: *** [mancheck] Error 1


BR,
Jani.


>  ENVIRONMENT
>  ===========

-- 
Jani Nikula, Intel Open Source Technology Center