Project

General

Profile

Bug #5041

Ensure VTY reference is automatically generated / updated

Added by laforge 11 days ago. Updated 11 days ago.

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

90%

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

Associated revisions

Revision 67a3c833 (diff)
Added by laforge 11 days ago

main: add --vty-ref-mode, use vty_dump_xml_ref_mode()

Change-Id: I966715ab2a430497bbccf26c50aef72d0901997f
Depends: Ie2022a7f9e167e5ceacf15350c037dd43768ff40
Related: OS#5041

Revision 17cee205 (diff)
Added by laforge 11 days ago

manuals: generate vty reference xml at build time

Remove ggsn_vty_reference from the source tree.

In manuals/Makefile.am use the new BUILT_REFERENCE_XML feature recently added
to osmo-gsm-manuals, and add a build target to generate the XML using the new
osmo-ggsn --vty-ref-xml cmdline switch.

Change-Id: I772293cc78a6c95e07565a7048c1c8dadf87d2fc
Depends: I613d692328050a036d05b49a436ab495fc2087ba
Related: OS#5041

Revision 6d8d9b3c (diff)
Added by laforge 11 days ago

main: add --vty-ref-mode, use vty_dump_xml_ref_mode()

Change-Id: Ia5abf7457ee7e97ec3fcd5520e5ef82ef808667a
Related: OS#5041
Depends: Ie2022a7f9e167e5ceacf15350c037dd43768ff40

Revision 2181d644 (diff)
Added by laforge 11 days ago

manuals: generate vty reference xml at build time

Rremove osmo-stp_vty_reference from the source tree.

In manuals/Makefile.am use the new BUILT_REFERENCE_XML feature recently added
to osmo-gsm-manuals, and add a build target to generate the XML using the new
osmo-stp --vty-ref-xml cmdline switch.

Change-Id: I5bcbbdf7b737d2ce36ea877bc78c8cf191a64e1b
Depends: I613d692328050a036d05b49a436ab495fc2087ba
Related: OS#5041

Revision 2bd1a455 (diff)
Added by laforge 11 days ago

main: add --vty-ref-mode, use vty_dump_xml_ref_mode()

Change-Id: I939f75d6c03145dbe185d849b95b2dd99782f35c
Depends: Ie2022a7f9e167e5ceacf15350c037dd43768ff40
Related: OS#5041

Revision 8c9087dd (diff)
Added by laforge 11 days ago

manuals: generate vty reference xml at build time

Move 'doc' subdir further down to "make sure" the osmo-hlr binary is built
before the docs

Remove hlr_vty_reference from the source tree.

In manuals//Makefile.am use the new BUILT_REFERENCE_XML feature recently added
to osmo-gsm-manuals, and add a build target to generate the XML using the new
osmo-hlr --vty-ref-xml cmdline switch.

Change-Id: I02c9862ced48ce4271b328a0963d5f09086b295c
Depends: I613d692328050a036d05b49a436ab495fc2087ba
Related: OS#5041

Revision 356f49e7 (diff)
Added by laforge 11 days ago

manuals: generate vty reference xml at build time

Remove hnbgw_vty_reference from the source tree.

In manuals/Makefile.am use the new BUILT_REFERENCE_XML feature recently added
to osmo-gsm-manuals, and add a build target to generate the XML using the new
osmo-hnbgw --vty-ref-xml cmdline switch.

Change-Id: Ia1e978ad9139c41368cd2720c339e1738d345c4a
Depends: I613d692328050a036d05b49a436ab495fc2087ba
Related: OS#5041

History

#1 Updated by fixeria 11 days 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'.

#2 Updated by pespin 11 days ago

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

#3 Updated by laforge 11 days 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

#4 Updated by laforge 11 days ago

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

#5 Updated by laforge 11 days ago

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

#6 Updated by laforge 11 days ago

  • Checklist item osmo-iuh set to Done

#7 Updated by laforge 11 days 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.

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)