You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I just tried reading the documentation in man editorconfig, as installed by an Arch Linux package. It doesn't actually explain what the editorconfig program does, what a FILEPATH is or what the expected output is.
I am aware of what the EditorConfig project does in general and I already have a valid .editorconfig file, but how to use /usr/bin/editorconfig remains a mystery after reading this man page.
The text was updated successfully, but these errors were encountered:
I figured out how to use it -- it seems I needed to use absolute path names. I still think the man page could use a few more words to explain what it does though.
The linked package appears to have been replaced by https://aur.archlinux.org/packages/editorconfig-core-c-git/ . The manpage comes straight from this project; I have attached a copy of what I get on my system. I agree the manpage isn't great, but it's not intended to be user-facing. I am going to change this issue to updating the manpage source (editorconfig.h, @page editorconfig) to point users to the Web site or other appropriate documentation. Make sense?
cxw42
changed the title
Man page fails to explain what editorconfig is or does
Update manpage text in editorconfig.h to point users to editorconfig.org [edited]
Aug 11, 2021
I just tried reading the documentation in
man editorconfig
, as installed by an Arch Linux package. It doesn't actually explain what theeditorconfig
program does, what aFILEPATH
is or what the expected output is.I am aware of what the EditorConfig project does in general and I already have a valid
.editorconfig
file, but how to use/usr/bin/editorconfig
remains a mystery after reading this man page.The text was updated successfully, but these errors were encountered: