Ceph

h1. Annotate config options

h3. Summary

Annotate config options in the code; auto-generate docs based on annotations

h3. Owners

* Danny Al-Gaaf (Deutsche Telekom AG)

* Name (Affiliation)

* Name

h3. Interested Parties

* Sage Weil (Inktank)

* Name (Affiliation)

* Name

h3. Current Status

Config options are enumerated in common/config_opts.h

p((. name

type

default value

Options are documented (sometimes) via source code comments

Options are documented (sometimes) as rst.

Docs and options are not in sync.

Config options (values) can be dumped via the admin socket

h3. Detailed Description

Make the config options be defined *and* documented all in one place.

Expand the current config option macro to include

p((. description

daemon types (common, mon, osd, client, librados, etc.); command separated list

class (general, performance, debug, ...?)

Make the admin socket dump those descriptions in json (or simiar)

Autogenerate the .rst docs from that. 

h3. Work items

h4. Coding tasks

# define daemon type keywords

# define config option categories

# config: expand the config macro

# asok: make a config dump command that includes the descriptions

# doc: make a simple tool that dumps the config options in rst

## this should take a daemon type or list of types so that we can document 'radosgw options' that include rgw and common

h4. Documentation tasks

# replace existing docs with generated ones

# ensure that the script to do this is in an easy to find location (ceph.git/admin?)

h4. Pad

http://pad.ceph.com/p/cdsgiant-annot...g-perfcounters