Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add Man pages #464

Merged
merged 2 commits into from
Sep 15, 2016
Merged

Add Man pages #464

merged 2 commits into from
Sep 15, 2016

Conversation

alx741
Copy link
Contributor

@alx741 alx741 commented Sep 15, 2016

This is the first attempt to add man pages for the utilities (#208)

Only the man page for st-util is ready, if this is useful I will make the pages for the other binaries as well.

The Cmake rules are modified so doing sudo make install installs the man pages. Then doing man st-util works just fine.

The makrdown man pages need to be generated first by doing make in the doc/man directory. Maybe integrate this in the Cmake rules (?)

@texane texane merged commit 51a7e0a into stlink-org:master Sep 15, 2016
@texane
Copy link
Collaborator

texane commented Sep 15, 2016

Merged it but some modifications done. More work needed here, cf. following
commits logs.

2016-09-15 5:20 GMT+02:00 Daniel Campoverde notifications@github.com:

This is the first attempt to add man pages for the utilities (#208
#208)

Only the man page for st-util is ready, if this is useful I will make the
pages for the other binaries as well.

The Cmake rules are modified so doing sudo make install installs the man
pages. Then doing man st-util works just fine.

The makrdown man pages need to be generated first by doing make in the

doc/man directory. Maybe integrate this in the Cmake rules (?)

You can view, comment on, or merge this pull request online at:

#464
Commit Summary

  • Add man page installation to Cmake rules
  • Add st-util man page

File Changes

Patch Links:


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#464, or mute the thread
https://github.com/notifications/unsubscribe-auth/AAEeH1GF7EXR7vVWglQZmb0RN2XaPt1vks5qqLl_gaJpZM4J9dg-
.

@xor-gate
Copy link
Member

xor-gate commented Sep 15, 2016

@alx741 looking good, we can continue discussion in #208 if you want. I will do some work before v1.3.0 release to integrate with cmake. Maybe you can create also man pages for the other cli tools.

@alx741
Copy link
Contributor Author

alx741 commented Sep 15, 2016

@xor-gate sure, I'll work on The other pages today

@Nightwalker-87 Nightwalker-87 added this to the v1.3.0 milestone Mar 16, 2020
@Nightwalker-87 Nightwalker-87 mentioned this pull request Mar 16, 2020
@Nightwalker-87 Nightwalker-87 linked an issue Mar 17, 2020 that may be closed by this pull request
@stlink-org stlink-org locked as resolved and limited conversation to collaborators Apr 14, 2020
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add UNIX man pages
4 participants