Project

General

Profile

Actions

Documentation #48301

closed

Change option name references to the underscore versions

Added by Anthony D'Atri over 3 years ago. Updated over 3 years ago.

Status:
Resolved
Priority:
Normal
Category:
documentation
Target version:
-
% Done:

0%

Tags:
documentation
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

Ceph has long allowed config options to be specified with spaces or underscores in ceph.conf, eg. mon target pg per osd and mon_target_pg_per_osd.

I have always favored using underscores - they make the option name clearly delimited, easier to cut/paste, and easier to grep for.

Mimic-style centralized config displays options with underscores,

src/common/options.cc uses underscores.

The only place we use spaces ... is documentation. eg. https://docs.ceph.com/en/latest/rados/configuration/osd-config-ref/#general-settings

So I propose that we wholesale update config option references throughout the doc tree. I'll volunteer to work on this, but @zdover23 I wanted to run it by you first.

Actions #1

Updated by Zac Dover over 3 years ago

Proceed!

Actions #2

Updated by Anthony D'Atri over 3 years ago

Aye Aye, Cap'n!

Actions #3

Updated by Neha Ojha over 3 years ago

  • Status changed from New to Fix Under Review
  • Assignee set to Anthony D'Atri
  • Pull request ID set to 38580
Actions #5

Updated by Nathan Cutler over 3 years ago

  • Status changed from Fix Under Review to Resolved

I would respectfully suggest to not backport this one.

Actions

Also available in: Atom PDF