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

Update manpage text in editorconfig.h to point users to editorconfig.org [edited] #27

Open
craigbarnes opened this issue Jul 26, 2017 · 3 comments

Comments

@craigbarnes
Copy link

craigbarnes commented Jul 26, 2017

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.

@craigbarnes
Copy link
Author

craigbarnes commented Jul 26, 2017

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.

@cxw42
Copy link
Member

cxw42 commented Aug 11, 2021

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 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
@xuhdev
Copy link
Member

xuhdev commented Aug 11, 2021

Makes sense to me 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants