<blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;"><p style="white-space: pre-wrap; word-wrap: break-word;">I associate 'man' with the unix manpages. IIUC we are generating / going to generate manpages from this, but IMHO this should be called 'manuals'; or rather, just be directly in the doc/ dir, after all, "documentation / manuals" is redundant.</p></blockquote><p style="white-space: pre-wrap; word-wrap: break-word;">I agree with the name being confusing for manpages, so I welcome suggestions for better folder names. And yes, the plan is to generate manpages eventually. There's a separate issue for this: https://osmocom.org/issues/3386</p><p style="white-space: pre-wrap; word-wrap: break-word;">If we did place the files directly in the doc folder, what about the project repositories that already have files in there? I think it would be good to separate the files that end up in the PDFs from the files that are meant to be read otherwise. Also some doc folders already have Makefile.am inside (see below).</p><p style="white-space: pre-wrap; word-wrap: break-word;">My idea was to have this commit a blueprint to how to do it with the other repositories as well, so it would be nice if we could find a solution that works for all projects.</p><p style="white-space: pre-wrap; word-wrap: break-word;">How about "doc/manuals" then? Or "doc/pdf"?</p><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><br> $ for i in *; do [ -d "$i/doc" ] || continue; echo ":: $i/doc"; ls $i/doc; done<br> :: libosmocore/doc<br> vty<br> :: libosmo-sccp/doc<br> Makefile.am Makefile.in examples<br> :: osmo-bsc/doc<br> BS11-OML.txt assignment-fsm.dot handover-inter-bsc-in.msc lchan.msc mgw-endpoint.msc<br> Makefile e1-data-model.txt handover-inter-bsc-in-fsm.dot lchan-fsm.dot mgw-endpoint-fsm.dot<br> Makefile.am examples handover-inter-bsc-out.msc lchan-rtp-fsm.dot timeslot.msc<br> Makefile.in handover.msc handover-inter-bsc-out-fsm.dot legend_for_fsm_diagrams.dot timeslot-fsm.dot<br> assignment.msc handover.txt handover-intra-bsc-fsm.dot legend_for_ladder_diagrams.msc ts-and-lchan-fsm-lifecycle.msc<br> :: osmo-bts/doc<br> Makefile.am control_interface.txt examples phy_link.txt startup.txt<br> :: osmo-ggsn/doc<br> Compliance.html Makefile.am Makefile.in examples osmo-ggsn.8 sgsnemu.8<br> :: osmo-hlr/doc<br> Makefile.am Makefile.in examples<br> :: osmo-iuh/doc<br> Makefile.am README hnb_cs_lu.msc hnb_cs_mo_sms.msc hnb_cs_mt_sms.msc hnb_ps_pdp_act.msc<br> Makefile.in examples hnb_cs_mo_call.msc hnb_cs_mt_call.msc hnb_ps_lu.msc protocols_around_hnbgw.txt<br> :: osmo-mgw/doc<br> Makefile.am Makefile.in examples<br> :: osmo-msc/doc<br> Makefile.am Makefile.in examples man<br> :: osmo-sgsn/doc<br> Makefile.am Makefile.in examples<br> :: osmo-sip-connector/doc<br> Makefile.am Makefile.in examples<br> :: osmo-trx/doc<br> Makefile.am Makefile.in examples<br> :: osmo-ttcn3-hacks/doc<br> osmodevcon2018-ttcn3_test_suites.adoc</pre><p><a href="https://gerrit.osmocom.org/11726">View Change</a></p><p>2 comments:</p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0;"><p><a href="https://gerrit.osmocom.org/#/c/11726/1/.gitignore">File .gitignore:</a></p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.osmocom.org/#/c/11726/1/.gitignore@66">Patch Set #1, Line 66:</a> <code style="font-family:monospace,monospace">*.html</code></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">Seems that the manuals get generated in the root dir of the {source,build} tree? I would prefer a su […]</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">They get generated in the manuals folder (doc/man currently). Some files also end up in a "generated" subfolder (like it is the case with the current build scripts in osmo-gsm-manuals.git), so doc/man/generated.</p></li></ul></li><li style="margin: 0; padding: 0;"><p><a href="https://gerrit.osmocom.org/#/c/11726/1/doc/man/chapters/counters_generated.adoc">File doc/man/chapters/counters_generated.adoc:</a></p><ul style="list-style: none; padding: 0;"><li style="margin: 0; padding: 0 0 0 16px;"><p style="margin-bottom: 4px;"><a href="https://gerrit.osmocom.org/#/c/11726/1/doc/man/chapters/counters_generated.adoc@6">Patch Set #1, Line 6:</a> <code style="font-family:monospace,monospace">.msc - mobile switching center </code></p><p><blockquote style="border-left: 1px solid #aaa; margin: 10px 0; padding: 0 10px;">whitespace</blockquote></p><p style="white-space: pre-wrap; word-wrap: break-word;">It says "// autogenerated by show asciidoc counters" on top and it was copy pasted from osmo-gsm-manuals.git's OsmoMSC folder. Should we change it anyway?</p></li></ul></li></ul><p>To view, visit <a href="https://gerrit.osmocom.org/11726">change 11726</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/11726"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-msc </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: comment </div>
<div style="display:none"> Gerrit-Change-Id: I2f9c27f81940b02414f0e618483bffade72e8cf7 </div>
<div style="display:none"> Gerrit-Change-Number: 11726 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: osmith <osmith@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Pau Espin Pedrol <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: osmith <osmith@sysmocom.de> </div>
<div style="display:none"> Gerrit-Comment-Date: Tue, 13 Nov 2018 13:07:02 +0000 </div>
<div style="display:none"> Gerrit-HasComments: Yes </div>
<div style="display:none"> Gerrit-HasLabels: No </div>