Project

General

Profile

Feature #3385

Move project specific manuals from osmo-gsm-manuals to each respective git repository

Added by pespin 3 months ago.

Status:
New
Priority:
Normal
Assignee:
sysmocom
Target version:
-
Start date:
07/06/2018
Due date:
% Done:

0%

Estimated time:
Spec Reference:

Description

Following subdirs in osmo-gsm-manuals.git should be moved under doc subdir of each respective git repository (osmo-bsc.git, osmo-bts.git, etc.)

OsmoBSC
OsmoBTS
OsmocomBB
OsmoGGSN
OsmoGSMTester
OsmoHLR
OsmoMGCP
OsmoMGW
OsmoMSC
OsmoNAT
OsmoNITB
OsmoPCU
OsmoSGSN
OsmoSTP
OsmoTRX

The idea is to keep the common parts and build related scripts (makefile, etc) in osmo-gsm-manuals.git, and then conditionally enable building them by using a configure flag (eg. --enable-man --with-man-path=/path/to/osmo-gsm-manuals.git/).

We can have most of the Makefile logic in a .mk file in osmo-gsm-manuals.git and include it in every repository, similar to what we do with osmo-release.mk from libosmocore.git:
In configure.ac:

dnl include release helper
RELMAKE='-include osmo-release.mk'
AC_SUBST([RELMAKE])

This way we can have user manual and VTY documentation up to date and sync with code, and force to have documentation changes together with code changes in the same gerrit patch before +2 it.

This will also allow to easily generate man pages from a specific .adoc file (which is also included in user manual).


Related issues

Related to OsmoBSC - Feature #3583: OsmoBSC manual: copy/move bts-examples chapter from OsmoNITBNew2018-09-20

Precedes Cellular Network Infrastructure - Feature #3386: Generate man pages at build time from adoc filesNew2018-07-092018-07-09

History

#1 Updated by pespin 3 months ago

  • Precedes Feature #3386: Generate man pages at build time from adoc files added

#2 Updated by neels 4 days ago

  • Related to Feature #3583: OsmoBSC manual: copy/move bts-examples chapter from OsmoNITB added

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)