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.

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

docs,man: Commit generated man files into docs/man/ #2289

Merged
merged 1 commit into from
Nov 1, 2019

Conversation

k-takata
Copy link
Member

@k-takata k-takata commented Nov 1, 2019

Fix the issue in #2213 (comment).

Replace the placeholders like @CTAGS_NAME_EXECUTABLE@ with ctags and
so on, so that the man pages can be shown correctly on the Web site.

The files under docs/man/ need to be updated manually:

$ make -C man QUICK=1 update-docs

So a checker for that is added to Travis CI.

Now the docs/man/ files are not symlinks, so they can be correctly
handled on Windows. A workaround on AppVeyor is not needed.

Fix the issue in universal-ctags#2213 (comment).

Replace the placeholders like `@CTAGS_NAME_EXECUTABLE@` with `ctags` and
so on, so that the man pages can be shown correctly on the Web site.

The files under docs/man/ need to be updated manually:

```
$ make -C man QUICK=1 update-docs
```

So a checker for that is added to Travis CI.

Now the docs/man/ files are not symlinks, so they can be correctly
handled on Windows. A workaround on AppVeyor is not needed.
@coveralls
Copy link

Coverage Status

Coverage remained the same at 86.312% when pulling c18e8e4 on k-takata:generate-docs-man into 82788f6 on universal-ctags:master.

@k-takata
Copy link
Member Author

k-takata commented Nov 1, 2019

Hmm, it seems that the indentation of misc/travis-check.sh is inconsistent.
Some part is indented with space and some other part is indented with tab.

The settings of .editorconfig are:

[*.{c,h,sh}]
indent_size = 4
indent_style = tab
trim_trailing_whitespace = true

So, should we use tab?

@masatake
Copy link
Member

masatake commented Nov 1, 2019

Nice!

@k-takata k-takata merged commit a6684bd into universal-ctags:master Nov 1, 2019
@k-takata k-takata deleted the generate-docs-man branch November 1, 2019 16:34
k-takata added a commit to k-takata/ctags that referenced this pull request Nov 2, 2019
Write about updating the files in ../docs/man/.

Related: universal-ctags#2289
@k-takata k-takata mentioned this pull request Nov 2, 2019
k-takata added a commit to k-takata/ctags that referenced this pull request Nov 10, 2019
It should have been updated after universal-ctags#2259.
Also related to universal-ctags#2289.
@k-takata k-takata mentioned this pull request Nov 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants