Project

General

Profile

Actions

Bug #6691

closed

User story #6659: Man pages for the rudder command

Bug #6689: Man pages for rudder commands introduced in 3.1

Add support for command options or arguments

Added by Alexis Mousset almost 9 years ago. Updated over 8 years ago.

Status:
Released
Priority:
N/A
Category:
Documentation
Target version:
Severity:
UX impact:
User visibility:
Effort required:
Priority:
Name check:
Fix check:
Regression:

Description

Add a simple syntax for command options and arguments:

# @argument node: node ip or address
# @argument [-s]: start the service
Actions #1

Updated by Alexis Mousset almost 9 years ago

Add a simple syntax for options and agruments to have a complete man page.

# @argument node: node ip or hostname
# @argument [-s]: start the service
Actions #2

Updated by Alexis Mousset almost 9 years ago

  • Status changed from New to In progress
Actions #3

Updated by Benoît PECCATTE almost 9 years ago

This is a bit unclear.
What is the goal of @argument and how will it be used ?

If this is only for documentation, isn't @man sufficient ?

Actions #4

Updated by Alexis Mousset almost 9 years ago

That would allow to display the arguments on the same line:

   server
       commands for rudder server, run with rudder server command

       debug [--truc] <node>
           run a debug cf-serverd intended for a specific node. This command targets a specific node and does not affect the running infrastructure. It uses iptables to redirect the specific node communications to the port the debug server is listening on (5310 by default).

           Use Ctrl+C to stop the debug server.

           Arguments:
           node: node ip or address

But it is not that important, and using asciidoc syntax in the @man is enough for the list of arguments/options in the section.

Actions #5

Updated by Alexis Mousset almost 9 years ago

  • Status changed from In progress to Pending technical review
  • Assignee changed from Alexis Mousset to Benoît PECCATTE
  • Pull Request set to https://github.com/Normation/rudder-agent/pull/14

PR https://github.com/Normation/rudder-agent/pull/14

Using asciidoc in the @man section.

Actions #6

Updated by Alexis Mousset almost 9 years ago

  • Status changed from Pending technical review to Pending release
  • % Done changed from 0 to 100
Actions #8

Updated by Vincent MEMBRÉ over 8 years ago

  • Status changed from Pending release to Released

This bug has been fixed in Rudder 3.0.6 and 3.1.0~rc1 which were released on the 16th June 2015.

Actions

Also available in: Atom PDF