Skip to content

Docs: get rid of the optlib man page and just point to docs.ctags.io #1835

Open
@hadrielk

Description

@hadrielk

I was updating the man page for optlib (man/ctags-optlib.7.rst.in), and it feels very redundant with the optlib "Extending ctags" chapter of http://docs.ctags.io, mostly from docs/optlib.rst.

So I'm wondering: why do we need to document this stuff twice? Why don't we just have the main man page say to go read http://docs.ctags.io/en/latest/extending.html for details about extending ctags? We can still list the non-experimental optlib options in the main man page, as they mostly already are, but just say to go read http://docs.ctags.io/en/latest/extending.html for details.

I don't think people will be annoyed at having to go online to read about extending ctags - it's not simple/basic usage, really.

Even the current main man page feels too big and too detailed, in my opinion. I mean this isn't the 1980's. People have internet access. The man page should give the basics, but details could be left for online docs. For example, the section on "Guessing parser", "OPERATIONAL DETAILS", "How to use with ", and perhaps even "TAG FILE FORMAT" - those can go online only. But that's just my opinion, and perhaps too radical.(?)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions