osmith has posted comments on this change. ( https://gerrit.osmocom.org/11726 )
Change subject: move project specific manuals to their own repos ...................................................................... Patch Set 1: (2 comments) > 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. 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 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). 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. How about "doc/manuals" then? Or "doc/pdf"? $ for i in *; do [ -d "$i/doc" ] || continue; echo ":: $i/doc"; ls $i/doc; done :: libosmocore/doc vty :: libosmo-sccp/doc Makefile.am Makefile.in examples :: osmo-bsc/doc BS11-OML.txt assignment-fsm.dot handover-inter-bsc-in.msc lchan.msc mgw-endpoint.msc Makefile e1-data-model.txt handover-inter-bsc-in-fsm.dot lchan-fsm.dot mgw-endpoint-fsm.dot Makefile.am examples handover-inter-bsc-out.msc lchan-rtp-fsm.dot timeslot.msc Makefile.in handover.msc handover-inter-bsc-out-fsm.dot legend_for_fsm_diagrams.dot timeslot-fsm.dot assignment.msc handover.txt handover-intra-bsc-fsm.dot legend_for_ladder_diagrams.msc ts-and-lchan-fsm-lifecycle.msc :: osmo-bts/doc Makefile.am control_interface.txt examples phy_link.txt startup.txt :: osmo-ggsn/doc Compliance.html Makefile.am Makefile.in examples osmo-ggsn.8 sgsnemu.8 :: osmo-hlr/doc Makefile.am Makefile.in examples :: osmo-iuh/doc Makefile.am README hnb_cs_lu.msc hnb_cs_mo_sms.msc hnb_cs_mt_sms.msc hnb_ps_pdp_act.msc Makefile.in examples hnb_cs_mo_call.msc hnb_cs_mt_call.msc hnb_ps_lu.msc protocols_around_hnbgw.txt :: osmo-mgw/doc Makefile.am Makefile.in examples :: osmo-msc/doc Makefile.am Makefile.in examples man :: osmo-sgsn/doc Makefile.am Makefile.in examples :: osmo-sip-connector/doc Makefile.am Makefile.in examples :: osmo-trx/doc Makefile.am Makefile.in examples :: osmo-ttcn3-hacks/doc osmodevcon2018-ttcn3_test_suites.adoc https://gerrit.osmocom.org/#/c/11726/1/.gitignore File .gitignore: https://gerrit.osmocom.org/#/c/11726/1/.gitignore@66 PS1, Line 66: *.html > Seems that the manuals get generated in the root dir of the {source,build} > tree? I would prefer a su […] 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. https://gerrit.osmocom.org/#/c/11726/1/doc/man/chapters/counters_generated.adoc File doc/man/chapters/counters_generated.adoc: https://gerrit.osmocom.org/#/c/11726/1/doc/man/chapters/counters_generated.adoc@6 PS1, Line 6: .msc - mobile switching center > whitespace 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? -- To view, visit https://gerrit.osmocom.org/11726 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-msc Gerrit-Branch: master Gerrit-MessageType: comment Gerrit-Change-Id: I2f9c27f81940b02414f0e618483bffade72e8cf7 Gerrit-Change-Number: 11726 Gerrit-PatchSet: 1 Gerrit-Owner: osmith <osm...@sysmocom.de> Gerrit-Reviewer: Jenkins Builder (1000002) Gerrit-Reviewer: Neels Hofmeyr <nhofm...@sysmocom.de> Gerrit-Reviewer: Pau Espin Pedrol <pes...@sysmocom.de> Gerrit-Reviewer: osmith <osm...@sysmocom.de> Gerrit-Comment-Date: Tue, 13 Nov 2018 13:07:02 +0000 Gerrit-HasComments: Yes Gerrit-HasLabels: No
