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

Issues in README.md #5

Open
masatake opened this issue Feb 13, 2021 · 1 comment · May be fixed by #6
Open

Issues in README.md #5

masatake opened this issue Feb 13, 2021 · 1 comment · May be fixed by #6
Assignees

Comments

@masatake
Copy link
Member

https://github.com/universal-ctags/codebase/README.rst is well documented.
The followings are my comments.

The followings are my understanding (or guess). Should be described.

  • A codebase must have a git repository.
  • If CTAGS_EXE is not defined ctags is used.
  • ALIGNMENT in *.lcopy is mandatory or optional (HEAD)?
    • there are pros and cons

typo:

$ ./codebae clone C

How to add your code to code base

"How to add a new code base" may be better.

BTW Which is correct, "codebase" or "core base"?

How to add your profile to preset list

It took some minutes for me to understand this section.
First I thought this was something mandatory.

"How to add a new profile" may be better as above.

You have to write a .ctags file and put it to profile.d directory.

Words "have to" confused me.
How about the following?

Add a .ctags file under profile.d directory.

A line started from "# @" is used as a description for the profile.

Does this mean a "comment line"?

You may wan to use --options-maybe to extend profile without modifying existing .ctags files.

I don't understand this sentence.

Originally posted by @hirooih in universal-ctags/ctags#2863 (comment)

@masatake masatake self-assigned this Feb 16, 2021
@masatake
Copy link
Member Author

@hirooih, thank you for the comment. I will update README.rst.

codebase is the name of the command and the project.
code base means a director where the source code getting from git repositories is stored.

I should write "codebase command" instead of just codebase.

masatake added a commit that referenced this issue Feb 17, 2021
Signed-off-by: Masatake YAMATO <yamato@redhat.com>
@masatake masatake linked a pull request Feb 17, 2021 that will close this issue
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 a pull request may close this issue.

1 participant