Project

General

Profile

Actions

Task #1446

closed

NFD documentation and manpages

Added by Alex Afanasyev about 10 years ago. Updated almost 10 years ago.

Status:
Closed
Priority:
Normal
Category:
Tools
Target version:
Start date:
Due date:
% Done:

100%

Estimated time:

Description

NFD documentation should contain tutorial sections (installation instruction, configuration tips, etc.).

Also, each executable bundled in NFD needs a man page.

The skeleton for manpages is in docs folders and the following process is to create a new page:

  • add new .rst file in docs/manpages
  • modify man_pages variable in docs/conf.py
Actions #1

Updated by Junxiao Shi about 10 years ago

  • Category set to Tools
  • Target version set to v0.1
Actions #2

Updated by Alex Afanasyev about 10 years ago

  • Subject changed from NFD manpages to NFD documentation and manpages
  • Description updated (diff)
  • % Done changed from 0 to 20
Actions #3

Updated by Alex Afanasyev about 10 years ago

  • Status changed from New to Code review
Actions #4

Updated by Alex Afanasyev about 10 years ago

  • % Done changed from 20 to 70
Actions #5

Updated by Alex Afanasyev about 10 years ago

  • Assignee set to Hila Ben Abraham

Hila, can you add manpages for the rest of command-line tools we have?

Actions #6

Updated by Hila Ben Abraham about 10 years ago

Sure, I can do that during the weekend.

Actions #7

Updated by Hila Ben Abraham about 10 years ago

Should I use Change-Id: I4f02f3166e7802570b24ed225ac4de8c56c6e64e ?

Actions #8

Updated by Alex Afanasyev about 10 years ago

Create a new commit (after this one is merged).

Actions #9

Updated by Hila Ben Abraham about 10 years ago

Should I use

./waf docs 

to generate the man pages? I tried but my build failed. (I can post the output if that's the right way to do it).

I just pushed Change-Id: I3eba0d125f7da51696342edce1a2f1ee33a0471a, but since the build failed, I couldn't verify it's actually working.

Actions #10

Updated by Alex Afanasyev about 10 years ago

Manpages are build during just ./waf (same as ./waf build).

Have you installed sphinx-build as described in README-dev.md? If so, did you reconfigure?

Actions #11

Updated by Alex Afanasyev about 10 years ago

Forgot to mention. Manpages are also part of the documentation that can be build with the command you mentioned (./waf docs). What errors you're getting and on which platform you're running it?

Actions #12

Updated by Hila Ben Abraham about 10 years ago

Just checked and sphinx-build is missing, I'll check again once I have it installed.

Actions #13

Updated by Alex Afanasyev about 10 years ago

If doxygen is missing, ./waf docs may also fail. However, there is ./waf sphinx to build just sphinx docs without API.

Actions #14

Updated by Alex Afanasyev about 10 years ago

  • Status changed from Code review to In Progress
Actions #15

Updated by Alex Afanasyev about 10 years ago

Hi Hila. Do you have progress on this issue?

Actions #16

Updated by Hila Ben Abraham about 10 years ago

I still have to complete the example section in each of the manpages. Sorry, I'm in the middle of my finals period, so I'm busy with other things. How urgent is this task?

Actions #17

Updated by Alex Afanasyev about 10 years ago

We need them before the release, which is coming very soon. If you can update the commit (even without example), we give some early comments/suggestions.

Actions #18

Updated by Alex Afanasyev almost 10 years ago

Let me know if you want this task to be re-assigned to someone else. We have 4 days till the release.

Actions #19

Updated by Hila Ben Abraham almost 10 years ago

Can you please re-assign 'nfd' manpage? I will push all the others tonight.

Actions #20

Updated by Syed Amin almost 10 years ago

I can do the nfd manpage.

Actions #21

Updated by Syed Amin almost 10 years ago

Hila, if you haven't finished nfdc manpage I can do it.

Actions #22

Updated by Syed Amin almost 10 years ago

Sorry, it was typo in my first message. I meant "nfdc" manpage not nfd.

Actions #23

Updated by Hila Ben Abraham almost 10 years ago

Thanks Syed, I have actually finished with nfdc...

Actions #24

Updated by Alex Afanasyev almost 10 years ago

  • Status changed from In Progress to Code review
  • % Done changed from 70 to 100
Actions #25

Updated by Alex Afanasyev almost 10 years ago

  • Status changed from Code review to Closed
Actions

Also available in: Atom PDF