1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
|
Description: create man page for the pathspec-rb binary
The pathspec-rb binary doesn't have a man page. The project's README file has
a handful of examples but the command line flags are not particularly
documented.
.
This patch creates a man page for the binary that can then be compiled
through debian/rules.
Author: Gabriel Filion <gabriel@koumbit.org>
Forwarded: https://github.com/highb/pathspec-ruby/pull/31
Applied-Upstream: https://github.com/highb/pathspec-ruby/pull/33, commit:9d7bfdcfac6b5447c5c5bed551037464eca5c4f8
--- /dev/null
+++ ruby-pathspec-0.2.1/pathspec-rb.man.1.rst
@@ -0,0 +1,62 @@
+===========
+pathspec-rb
+===========
+
+--------------------------------------
+Test pathspecs against a specific path
+--------------------------------------
+
+:Author: Gabriel Filion
+:Date: 2019
+:Manual section: 1
+
+Synopsis
+========
+
+| pathspec-rb [options] [subcommand] [path] <name> <path>
+
+Description
+===========
+
+``pathspc-rb`` is a tool that accompanies the pathspec-ruby library to help
+you test what match results the library would find using path specs. You can
+either find all specs matching a path, find all files matching specs, or
+verify that a path would match any spec.
+
+Sub-commands
+============
+
+| **specs_match** Find all specs matching path
+| **tree** Find all files under path matching the spec
+| **match** Check if the path matches any spec
+
+Options
+=======
+
+| **-f** | **--file** <FILENAME>
+| Load path specs from the file passed in as argument. If this option is
+| not specified, ``pathspec-rb`` defaults to loading ``.gitignore``.
+
+| **-t** | **--type** [``git``\ \|\ ``regex``]
+| Type of spec expected in the loaded specs file (see **-f** option).
+| Defaults to ``git``.
+
+| **-v** | **--verbose**
+| Only output if there are matches.
+
+Examples
+========
+
+Find all files ignored by git under your source directory::
+
+ $ pathspec-rb tree src/
+
+List all spec rules that would match for the specified path::
+
+ $ pathspec-rb specs_match build/
+
+Check that a path matches at least one of the specs in a new version of a
+gitignore file::
+
+ $ pathspec-rb match -f .gitignore.new spec/fixtures/
+
|