Project

General

Profile

Annotate config options » History » Version 2

Jessica Mack, 06/23/2015 09:32 PM

1 1 Jessica Mack
h1. Annotate config options
2 1 Jessica Mack
3 1 Jessica Mack
h3. Summary
4 1 Jessica Mack
5 1 Jessica Mack
Annotate config options in the code; auto-generate docs based on annotations
6 1 Jessica Mack
7 1 Jessica Mack
h3. Owners
8 1 Jessica Mack
9 1 Jessica Mack
* Danny Al-Gaaf (Deutsche Telekom AG)
10 1 Jessica Mack
* Name (Affiliation)
11 1 Jessica Mack
* Name
12 1 Jessica Mack
13 1 Jessica Mack
h3. Interested Parties
14 1 Jessica Mack
15 1 Jessica Mack
* Sage Weil (Inktank)
16 1 Jessica Mack
* Name (Affiliation)
17 1 Jessica Mack
* Name
18 1 Jessica Mack
19 1 Jessica Mack
h3. Current Status
20 1 Jessica Mack
21 1 Jessica Mack
Config options are enumerated in common/config_opts.h
22 1 Jessica Mack
23 2 Jessica Mack
p((. name
24 1 Jessica Mack
type
25 1 Jessica Mack
default value
26 1 Jessica Mack
27 1 Jessica Mack
Options are documented (sometimes) via source code comments
28 1 Jessica Mack
Options are documented (sometimes) as rst.
29 1 Jessica Mack
Docs and options are not in sync.
30 1 Jessica Mack
Config options (values) can be dumped via the admin socket
31 1 Jessica Mack
32 1 Jessica Mack
h3. Detailed Description
33 1 Jessica Mack
34 1 Jessica Mack
Make the config options be defined *and* documented all in one place.
35 1 Jessica Mack
 
36 1 Jessica Mack
Expand the current config option macro to include
37 1 Jessica Mack
38 2 Jessica Mack
p((. description
39 1 Jessica Mack
daemon types (common, mon, osd, client, librados, etc.); command separated list
40 1 Jessica Mack
class (general, performance, debug, ...?)
41 1 Jessica Mack
42 1 Jessica Mack
Make the admin socket dump those descriptions in json (or simiar)
43 1 Jessica Mack
Autogenerate the .rst docs from that. 
44 1 Jessica Mack
45 1 Jessica Mack
h3. Work items
46 1 Jessica Mack
47 1 Jessica Mack
h4. Coding tasks
48 1 Jessica Mack
49 1 Jessica Mack
# define daemon type keywords
50 1 Jessica Mack
# define config option categories
51 1 Jessica Mack
# config: expand the config macro
52 1 Jessica Mack
# asok: make a config dump command that includes the descriptions
53 1 Jessica Mack
# doc: make a simple tool that dumps the config options in rst
54 1 Jessica Mack
## this should take a daemon type or list of types so that we can document 'radosgw options' that include rgw and common
55 1 Jessica Mack
56 1 Jessica Mack
h4. Documentation tasks
57 1 Jessica Mack
58 1 Jessica Mack
# replace existing docs with generated ones
59 1 Jessica Mack
# ensure that the script to do this is in an easy to find location (ceph.git/admin?)
60 1 Jessica Mack
61 1 Jessica Mack
h4. Pad
62 1 Jessica Mack
63 1 Jessica Mack
http://pad.ceph.com/p/cdsgiant-annot...g-perfcounters