Project

General

Profile

Bug #2498

vty reference manuals are lacking node name/description

Added by laforge about 1 year ago. Updated 5 months ago.

Status:
Resolved
Priority:
Normal
Assignee:
Target version:
-
Start date:
09/06/2017
Due date:
% Done:

100%

Spec Reference:

Description

libosmocore/doc/vty/merge_doc.xsl works fine for merging in additional description or other elements for "commands", but it seems to fail for "nodes".

This results in section headings and descriptions missing, see e.g. the OsmoGGSN/vty/ggsn_vty_additions.xml or the same for SGSN and all other programs.

I'm not entirely sure if it was ever working, but in any case it needs to be fixed one way or another. I'm not good with XSLT. Feel free to ask around in the sysmocom team who feels most confident about this in case of questions.

History

#1 Updated by laforge 12 months ago

  • Assignee changed from pespin to neels

Hi Neels, I think you were touching this area most recently, hence the re-assign

#2 Updated by neels 11 months ago

  • Status changed from New to Resolved
  • % Done changed from 0 to 90

The merge_doc.xsl fix is fairly trivial https://gerrit.osmocom.org/5250 but also required (or at least suggested) regenerating the GGSN VTY reference.
Various spin-off patches are now submitted on gerrit, which can be considered part of this weeks' "documentation thursday" that still had some hours pending for me.

https://gerrit.osmocom.org/#/q/status:open+project:libosmocore+branch:master+topic:vty up to https://gerrit.osmocom.org/5254

https://gerrit.osmocom.org/#/q/status:open+project:osmo-gsm-manuals+branch:master+topic:ggsn_vty up to https://gerrit.osmocom.org/5258

#3 Updated by neels 11 months ago

  • Status changed from Resolved to In Progress

#4 Updated by neels 10 months ago

  • % Done changed from 90 to 70

all libosmocore changes are merged for this, yet we still need to re-generate the VTY references in osmo-gsm-manuals.git for those to take effect (manual process of updating the xml files from VTY output). So let me actually roll the percentage back a litte. OsmoGGSN is already completed, that's what I tested the new code with.

#5 Updated by neels 5 months ago

  • Status changed from In Progress to Resolved
  • % Done changed from 70 to 100

I have updated the vty references two months ago: https://gerrit.osmocom.org/#/q/branch:master+topic:vty-ref

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)