forked frompostgres/postgres
- Notifications
You must be signed in to change notification settings - Fork6
Commitcfb7559
committed
Doc: improve documentation of configuration settings that have units.
When we added the GUC units feature, we didn't make any great effortto adjust the documentation of individual GUCs; they tended to stillsay things like "this is the number of milliseconds that ...", eventhough users might prefer to write some other units, and SHOW mighteven show the value in other units. Commit6c9fb69 made an effortto improve this situation, but I thought it made things less readableby injecting units information in mid-sentence. It also wasn't veryconsistent, and did not touch all the GUCs that have units.To improve matters, standardize on the phrasing "If this value isspecified without units, it is taken as <units>". Also, try tostandardize where this is mentioned, right before the specificationof the default. (In a couple of places, doing that would've requiredmore rewriting than seemed justified, so I wasn't 100% consistentabout that.) I also tried to use the phrases "amount of time","amount of memory", etc rather than describing the contents of GUCsin other ways, as those were the majority usage in places that weren'tovercommitting to a particular unit. (I left "length of time" alonein a couple of places, though.)I failed to resist the temptation to copy-edit some awkward text, too.Backpatch to v12, like6c9fb69, mainly because v12 hasn't divergedmuch from HEAD yet.Discussion:https://postgr.es/m/15882.1571942223@sss.pgh.pa.us1 parent2fc2a88 commitcfb7559
1 file changed
+237
-146
lines changed0 commit comments
Comments
(0)