Bug 55901 – Documentation missing for some features of ldap.sh

Bug 55901 - Documentation missing for some features of ldap.sh


Summary:	Documentation missing for some features of ldap.sh

Status:	NEW

Product:	UCS extended documentation
Classification:	Unclassified
Component:	Developer documentation
Version:	unspecified
Hardware:	Other Linux

Importance:	P5 normal (vote)
Target Milestone:	---
Assigned To:	Docu maintainers
QA Contact:

URL:
Keywords:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2023-03-21 12:06 CET by Frank Greif
Modified:	2023-03-27 10:58 CEST (History)
CC List:	2 users (show)

See Also:
What kind of report is it?:	---
What type of bug is this?:	---
Who will be affected by this bug?:	---
How will those affected feel about the bug?:	---
User Pain:
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Frank Greif

2023-03-21 12:06:21 CET

The developer documentation lacks information about the helper functions introduced in #34556. Precisely, it's about the additional arguments

--udm_syntax_messagecatalog
--udm_module_messagecatalog
--udm_hook_messagecatalog

which were introduced to register message catalogs without fully-fledged umc modules. Given the fact that

. /usr/share/univention-lib/ldap.sh
ucs_registerLDAPExtension --help

does not help, the switches should at least be documented in https://docs.software-univention.de/developer-reference/5.0/en/join/write-join.html?highlight=ucs_regis#ldap-sh .

It would be desirable to especially document the fact that the mentioned switches do not register the catalog into the text domain named by the package name, but rather constructs the text domain from a constant string (for instance, 'univention-admin-syntax-' for a syntax) plus the base name of the extension .py file.