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

atf-sh-api(3) doesn't mention atf-check(1) #12

Closed
jmmv opened this issue Aug 13, 2014 · 2 comments
Closed

atf-sh-api(3) doesn't mention atf-check(1) #12

jmmv opened this issue Aug 13, 2014 · 2 comments
Labels

Comments

@jmmv
Copy link
Member

jmmv commented Aug 13, 2014

Originally filed by yaneurabeya at freebsd/kyua#98

atf-sh-api(3) mentions atf_check, but it doesn't reference atf-check(1), which could be helpful for folks getting started with atf.

@jmmv
Copy link
Member Author

jmmv commented Aug 13, 2014

The tool and manpage are mentioned under the "Helper functions for common checks" section. Feel free to add the reference to "See also" as well.

@jmmv
Copy link
Member Author

jmmv commented Aug 13, 2014

It does where atf_check is explained, but not in SEE ALSO.

The naming distinction between atf-check and atf_check is a bit unfortunate. Trying to run atf-check directly from test cases won't work because atf-check is installed in libexec, which is intended, so displaying the atf-check manpage more prominently would confuse users unless they also see the mention of atf_check.

If doing this, we'd need to change atf-check to clearly explain that it cannot be executed explicitly.

Another alternative would be to add a manpage for atf_check itself and maybe remove the one for atf-check.

@jmmv jmmv added the bug label Sep 8, 2014
@jmmv jmmv closed this as completed in a750539 Oct 6, 2014
lwhsu pushed a commit that referenced this issue Jan 15, 2024
atf-check: fix reporting wrong missing file name
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant