Create man pages for tar-diff and tar-patch
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 58/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- go
- Domain
- build-system, cli, documentation
Research direction
Create docs/man/tar-diff.1 and docs/man/tar-patch.1 after reviewing the tar-diff and tar-patch CLI options and usage examples. Add the make man target and connect the pages to make install; verify both pages render with man tar-diff and man tar-patch and are included in the RPM installation.
Written by the indexing model from the issue text.
Description
Create manual pages for the CLI tools to be included in the RPM package.
Tasks
- Create
docs/man/tar-diff.1man page - Create
docs/man/tar-patch.1man page - Add
make mantarget to generate/install man pages - Document all CLI options and usage examples
Acceptance Criteria
- Man pages render correctly with
man tar-diffandman tar-patch - Man pages included in
make install
- Dominant language
- Go
- Stars
- 66
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from containers/tar-diff
-
Create CHANGELOG.mdOpen
Difficulty 2/5 Half a day Newbie friendliness 65/100
containers/tar-diff#44 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
containers/tar-diff#37 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
containers/tar-diff#104 · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
containers/tar-diff#89 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
containers/tar-diff#88 ·
All issues in containers/tar-diff
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
google/differential-privacy#516 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
lightninglabs/lndmon#140 ·
-
documentation good first issue ready-for-triage ready-to-code
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
release-engineering/fbc-update-planner#102 · 3 comments ·
Maintainers usually reply within 5 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yetone/magpie#562 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 4 days