Project

General

Profile

Feature #3036

update vty reference -- and make it so that it can be done without manual edits

Added by neels 7 months ago. Updated 6 months ago.

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

0%

Estimated time:
Spec Reference:

Description

osmo-bts has a number of variants: osmo-bts-trx, osmo-bts-sysmo, etc., and each may have some differing VTY commands.
The way we currently generate the vty reference PDF in osmo-gsm-manuals is that we launch the program and issue 'show online-help' on the vty; this outputs an XML of all VTY commands and their docs.
But how do we produce one VTY reference for all of the various BTS types?

Should we change osmo-gsm-manuals to produce N different VTY references, one for each BTS model?
Should we somehow combine all generated XMLs?

Decide on the above, generate the VTY reference for each BTS model and update osmo-gsm-manuals.git with it.

Furthermore, osmo-bts-* usually exits right away when there is no BSC to connect to. That's a bit cumbersome when all you want to do is generate the VTY reference XML. Maybe we can introduce a cmdline switch to generate the XML instead of going through the VTY?

History

#1 Updated by laforge 6 months ago

  • Assignee set to neels

I think it's easiest to have separate reference manuals, one for each of the osmo-bts-* programs. This sticks with our existing tools, processes and the notion that we run one program and generat the vty reference for that program.

regarding osmo-bts exiting: it may be time to finally change that? This was a very early "fail fast" hack in 2011 or so.

#2 Updated by neels 6 months ago

laforge wrote:

I think it's easiest to have separate reference manuals, one for each of the osmo-bts-* programs. This sticks with our existing tools, processes and the notion that we run one program and generat the vty reference for that program.

ack

regarding osmo-bts exiting: it may be time to finally change that? This was a very early "fail fast" hack in 2011 or so.

(wrong issue? --> #3011?)

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)