Skip to content

Issues in README.md #5

Open
Open
@masatake

Description

@masatake

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)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions