[TS-3517] Combine various man page docs files into "grouped" files

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Fix Version/s: Docs
• Component/s: Documentation
• Assignee: Jon Sime
• Reporter: Leif Hedstrom
• Created: 12/Apr/15 20:43
• Updated: 12/Jun/15 23:18

Description

The intent, as far I used to know things, was that we'd group APIs by functionality, such that all Debug APIs goes into TSDebug.en.rst. This is the case for some APIs, but we now also have a lot of files (> 100) which only contains a single API. A good example is

doc/reference/api/TSMimeHdrFieldAppend.en.rst
doc/reference/api/TSMimeHdrFieldClone.en.rst
doc/reference/api/TSMimeHdrFieldCopy.en.rst
doc/reference/api/TSMimeHdrFieldCopyValues.en.rst
doc/reference/api/TSMimeHdrFieldCreate.en.rst
doc/reference/api/TSMimeHdrFieldDestroy.en.rst
doc/reference/api/TSMimeHdrFieldFind.en.rst
doc/reference/api/TSMimeHdrFieldGet.en.rst
doc/reference/api/TSMimeHdrFieldLengthGet.en.rst
doc/reference/api/TSMimeHdrFieldNameGet.en.rst
doc/reference/api/TSMimeHdrFieldNameSet.en.rst
doc/reference/api/TSMimeHdrFieldNext.en.rst
doc/reference/api/TSMimeHdrFieldNextDup.en.rst
doc/reference/api/TSMimeHdrFieldRemove.en.rst
doc/reference/api/TSMimeHdrFieldValueAppend.en.rst
doc/reference/api/TSMimeHdrFieldValueDateInsert.en.rst
doc/reference/api/TSMimeHdrFieldValueDateSet.en.rst
doc/reference/api/TSMimeHdrFieldValueIntSet.en.rst
doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst
doc/reference/api/TSMimeHdrFieldValueStringInsert.en.rst
doc/reference/api/TSMimeHdrFieldValueStringSet.en.rst
doc/reference/api/TSMimeHdrFieldValueUintInsert.en.rst
doc/reference/api/TSMimeHdrFieldValueUintSet.en.rst
doc/reference/api/TSMimeHdrFieldValuesClear.en.rst
doc/reference/api/TSMimeHdrFieldValuesCount.en.rst

I think this should be coalesced where it makes sense, e.g. the above ought to all be in one file, named TSMimeHdrField.en.rst.

Either that, or we undo the previous coalescing (look at TSDebug.en.rst), and split those out into one file per API. I definitely prefer the coalescing for sure, since it puts all useful information related to a particular set of APIs into one man page.

I think the commit in a549c31268729823781ee6fe6dff88196eb72589 introduced all these files.