Project

General

Profile

Actions

Bug #5041

closed

Ensure VTY reference is automatically generated / updated

Added by laforge 9 months ago. Updated 7 months ago.

Status:
Resolved
Priority:
Normal
Assignee:
Target version:
-
Start date:
02/23/2021
Due date:
% Done:

100%

Spec Reference:

Description

As far as I can tell, not all osmo-* programs do this yet.

Only the following have a BUILT_REFERENCE_XML in their Makefile.am:

osmo-bsc/doc/manuals/Makefile.am:  BUILT_REFERENCE_XML = $(builddir)/vty/bsc_vty_reference.xml
osmo-cbc/doc/manuals/Makefile.am:  BUILT_REFERENCE_XML = $(builddir)/vty/cbc_vty_reference.xml
osmo-gbproxy/doc/manuals/Makefile.am:  BUILT_REFERENCE_XML = $(builddir)/vty/gbproxy_vty_reference.xml
osmo-mgw/doc/manuals/Makefile.am:  BUILT_REFERENCE_XML = $(builddir)/vty/mgw_vty_reference.xml
osmo-msc/doc/manuals/Makefile.am:  BUILT_REFERENCE_XML = $(builddir)/vty/msc_vty_reference.xml
osmo-pcu/doc/manuals/Makefile.am:  BUILT_REFERENCE_XML = $(builddir)/vty/pcu_vty_reference.xml
osmo-sgsn/doc/manuals/Makefile.am:  BUILT_REFERENCE_XML = $(builddir)/vty/sgsn_vty_reference.xml
osmo-smlc/doc/manuals/Makefile.am:  BUILT_REFERENCE_XML = $(builddir)/vty/smlc_vty_reference.xml
This means at least the followign are missing:
  • osmo-bts (probably hidden due to the multiple per-model manuals?)
  • osmo-e1d
  • osmo-ggsn
  • osmo-hlr
  • osmo-iuh
  • osmo-pcap
  • osmo-trx
  • osmo-uecups

Checklist

  • osmo-ggsn
  • osmo-hlr
  • osmo-iuh
  • osmo-stp
Actions #1

Updated by fixeria 9 months ago

Hi Harald,

  • osmo-bts (probably hidden due to the multiple per-model manuals?)
  • osmo-trx

yes, they don't have BUILT_REFERENCE_XML, but define VARIANTS and include their own modified 'Makefile.vty-reference.inc'.

Actions #2

Updated by pespin 9 months ago

AFAIU that means osmo-stp (libosmo-sccp) is also missing?

Actions #3

Updated by laforge 9 months ago

  • Checklist item osmo-ggsn added
  • Checklist item osmo-e1d added
  • Checklist item osmo-hlr added
  • Checklist item osmo-iuh added
  • Checklist item osmo-pcap added
  • Checklist item osmo-stp added
Actions #4

Updated by laforge 9 months ago

  • Checklist item osmo-stp set to Done
  • % Done changed from 10 to 20
Actions #5

Updated by laforge 9 months ago

  • Checklist item osmo-hlr set to Done
  • Status changed from New to In Progress
  • % Done changed from 20 to 40
Actions #6

Updated by laforge 9 months ago

  • Checklist item osmo-iuh set to Done
Actions #7

Updated by laforge 9 months ago

  • Checklist item deleted (osmo-e1d)
  • Checklist item deleted (osmo-pcap)
  • % Done changed from 40 to 90

osmo-e1d, osmo-pcap and osmo-uecups have no user manuals at all yet, so removed them again from the list. That's probably a separate issue to be tracked elsewhere.

Actions #8

Updated by laforge 7 months ago

  • Status changed from In Progress to Resolved
  • % Done changed from 90 to 100
Actions

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)