Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise the code for loading configuration files #1519

Merged
merged 27 commits into from
Oct 13, 2017
Merged

Revise the code for loading configuration files #1519

Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
d96bd36
main: introduce portable scandir implementation
masatake Aug 1, 2017
e7b4c94
Tmain: add --quiet --options=NONE to the test cmdlines
masatake Oct 3, 2017
bb5b123
main: fix typos
masatake Oct 3, 2017
79eec5d
main: print the progress of loading configuration files if in verbose…
masatake Oct 2, 2017
998a2d0
[SELF INCOMPATIBLE] main: remove --config-filename option
masatake Oct 2, 2017
343b834
[SELF INCOMPATIBLE] main: make CTAGS_DATA_PATH obsolete
masatake Oct 1, 2017
b8a4429
[SELF INCOMPATIBLE] main: make the feature loading configuration file…
masatake Oct 1, 2017
dc66026
[SELF INCOMPATIBLE] main: introduce --optlib-path option as the alter…
masatake Oct 1, 2017
ce0617a
[SELF INCOMPATIBLE][INCOMPATIBLE] main: rewrite code for loading conf…
masatake Oct 2, 2017
96767f1
main,refactor: remove installOptlibPathList function
masatake Oct 2, 2017
64f459f
[INCOMPATIBLE] main: don't load configuration file having .conf or .c…
masatake Oct 2, 2017
0128591
[SELF INCOMPATIBLE] main: don't limit files and directories .ctags an…
masatake Oct 2, 2017
c06b29f
Tmain: add cases for testing loading configuration files
masatake Oct 2, 2017
a828697
dicts: updated
masatake Oct 3, 2017
a334372
docs: write about new preload path and optlib feature
masatake Oct 6, 2017
c8f88a1
main,refactor: fix misdirected function name
masatake Oct 7, 2017
e076dab
main: update the description of --options in --help message
masatake Oct 7, 2017
609346c
docs(man): update FILES section
masatake Oct 7, 2017
5380404
Tmain: add a case for testing --optlib-dir option
masatake Oct 8, 2017
7f74e49
main: introduce --options-maybe
masatake Oct 8, 2017
d7b5120
docs(man): write about the incompatiblity about preload files
masatake Oct 8, 2017
05a89f4
docs(man): update the description for --options, and write about --op…
masatake Oct 8, 2017
1cdff28
docs(man): update README
masatake Oct 8, 2017
189645e
docs(man): fix grammetical errors in the description of --optlib-dir …
masatake Oct 9, 2017
31e3e74
docs(man): add a note on a preload file
masatake Oct 9, 2017
8e95a95
docs(web): fix a grammatical error
masatake Oct 9, 2017
6c25428
docs(README.md): write about new configuration files
masatake Oct 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(man): update the description for --options, and write about --op… 
…tlib-dir
  • Loading branch information
@masatake
masatake committed Oct 13, 2017
commit 05a89f4be1827a13e8dd663799c6ef25e0ef321c
39 changes: 24 additions & 15 deletions man/ctags.1.rst.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1321,21 +1321,30 @@ OPTION ITEMS
Limits the depth of directory recursion enabled with the ``--recurse``
(``-R``) option.

``--options=file|directory``
Read additional options from file or directory. If a file is specified,
it should contain one option per line. If a directory is specified
(and scandir function is available at build configuration time), files
suffixed with .ctags or .conf under the directory are read. (On MSDOS or
MSWindows this directory traverse feature is temporary disable because
the contributor of this feature has no access to the platforms.
Volunteers are welcome). As a special case, if "--options=NONE" is
specified as the first option on the command line, it will disable
the automatic reading of any configuration options from either a file
or the environment (see "FILES").

``--options-maybe=file|directory``
Does the same as ``--options`` but doesn't make an error if *file*
(or *directory*) doesn't exist.
``--optlib-dir=[+]directory``
Adds a directory to or reset **optlib** path list.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds better to replace "Adds" with "Add". You could also prefix "optlib" on this line and the next with "the" if there is enough room.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

The descriptions of the other options use "...s" like "Defines"(--langdef) for an example.
I wonder which I should use. Any criteria?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to be a mix already used. If you leave it as "Adds", should change "reset" to "resets".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated. My choice was "Add" as you suggested.

By default, optlib path list is empty.

``--options=pathname``
Read additional options from file or directory.

@CTAGS_NAME_EXECUTABLE@ searches *pathname* in optlib path list
first. If @CTAGS_NAME_EXECUTABLE@ cannot find a file or directory
in the list, @CTAGS_NAME_EXECUTABLE@ reads a file or directory
at the specified *pathname*.

If a file is specified, it should contain one option per line. If
a directory is specified, files suffixed with ".ctags" under it
are read in alphabetical order.

As a special case, if "--options=NONE" is specified as the first
option on the command line, preloading is disabled; the option
will disable the automatic reading of any configuration options
from either a file or the environment (see "FILES").

``--options-maybe=pathname``
Does the same as ``--options`` but doesn't make an error if file
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could replace "Does the same" with "Same" and "make an error" with "cause an error".

(or directory) specified with *pathname* doesn't exist.

``--print-language``
Just prints the parsers for specified source files, and then exits.
Expand Down