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

WIP: Add Unix manual pages #1484

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

WIP: Add Unix manual pages #1484

wants to merge 5 commits into from

Conversation

jtbx
Copy link

@jtbx jtbx commented Jan 10, 2023

This pull request adds Unix manual pages for each luarocks command.
A large amount of the content in these manuals are derived from the output of the luarocks help command.

I have a few questions:

  • Temporarily, I have put the manual pages in /man. What directory should they be in?
  • In the luarocks.1 manual page, I ordered the commands by how useful I think they are, and how much they will be used. Is this okay?

I used the OpenBSD mdoc format over groff, as it is easier to write for manuals and requires no preprocessing.

Closes #1483.

@codecov-commenter
Copy link

codecov-commenter commented Jan 10, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (fae768f) 79.06% compared to head (e018e95) 79.06%.

❗ Current head e018e95 differs from pull request most recent head 069860c. Consider uploading reports for the commit 069860c to get more accurate results

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1484   +/-   ##
=======================================
  Coverage   79.06%   79.06%           
=======================================
  Files          89       89           
  Lines       11065    11065           
=======================================
  Hits         8748     8748           
  Misses       2317     2317           
Impacted Files Coverage Δ
src/luarocks/upload/api.lua 63.84% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@jtbx jtbx marked this pull request as ready for review January 11, 2023 20:51
@daurnimator
Copy link
Member

A large amount of the content in these manuals are derived from the output of the luarocks help command.

luarocks --help is derived using argparse (https://github.com/luarocks/argparse).
Should that library perhaps gain some sort of manpage/groff output?

@alerque
Copy link
Contributor

alerque commented Mar 24, 2023

@daurnimator That would be nice 😁

@jtbx
Copy link
Author

jtbx commented Mar 29, 2023

@daurnimator Never used that library before but sounds good.

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

Successfully merging this pull request may close these issues.

Add Unix manual page
4 participants