diff --git a/common/utils/DOC/loader/arch.md b/common/utils/DOC/loader/arch.md index 53a1cc7ea2256a80d382f66eccd246811bb30107..c37aedb4ef9dbada3412f836a6ee692837ce1ecf 100644 --- a/common/utils/DOC/loader/arch.md +++ b/common/utils/DOC/loader/arch.md @@ -4,4 +4,4 @@ The oai shared library loader is implemented in two source files, located in [co 1. [load_module_shlib.c](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.c) contains the loader implementation 1. [load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.h) is the loader include file containing both private and public data type definitions. It also contain API prototypes. -[loader home page](loader) \ No newline at end of file +[loader home page](..loader.md) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage.md b/common/utils/DOC/loader/devusage.md index 89d15aa75ee9d406d3890b9ba921768dfc88ba1f..4b82e18362153f7c62c1a90afc4cfaf4da94bef3 100644 --- a/common/utils/DOC/loader/devusage.md +++ b/common/utils/DOC/loader/devusage.md @@ -5,13 +5,13 @@ The configuration module objectives are As a developer you may need to look at these sections: -* [loading a shared library](loader/devusage/loading) -* [loader API](loader/devusage/api) -* [loader public structures](loader/devusage/struct) +* [loading a shared library](devusage/loading.md) +* [loader API](devusage/api.md) +* [loader public structures](devusage/struct.md) Loader usage examples can be found in oai sources: * device and transport initialization code: [function `load_lib` in *targets/ARCH/COMMON/__common_lib.c__* ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/targets/ARCH/COMMON/common_lib.c#L91) * turbo encoder and decoder initialization: [function `load_codinglib`in *openair1/PHY/CODING/__coding_load.c__*](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/CODING/coding_load.c#L113) -[loader home page](loader) +[loader home page](../loader.md) diff --git a/common/utils/DOC/loader/devusage/api.md b/common/utils/DOC/loader/devusage/api.md index e01d69e9d4e3c4e77749d32cddcc83e9ea502c18..eabfe677e942e8a22c0ef08c4b3db3e23cf7b638 100644 --- a/common/utils/DOC/loader/devusage/api.md +++ b/common/utils/DOC/loader/devusage/api.md @@ -16,5 +16,5 @@ void * get_shlibmodule_fptr(char *modname, char *fname) ``` Returns a pointer to the symbol `fname`, defined in module `modname`, or `NULL` if the symbol is not found. -[loader home page](loader) -[loader developer home page](loader/devusage) \ No newline at end of file +[loader home page](../loader.md) +[loader developer home page](../devusage.md) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage/loading.md b/common/utils/DOC/loader/devusage/loading.md index e544830c032c811944279ed1cc40a089bc68ea0e..766bf854620779b9c20d688feb044273850b7b16 100644 --- a/common/utils/DOC/loader/devusage/loading.md +++ b/common/utils/DOC/loader/devusage/loading.md @@ -52,5 +52,5 @@ if (f2 != NULL) { ``` When loading a shared library the loader looks for a symbol named `< module name > _autoinit` and, if it finds it, calls it. The `autoinit` function is called without any argument and the returned value, if any, is not tested. -[loader home page](loader) -[loader developer home page](loader/devusage) \ No newline at end of file +[loader home page](../loader.md) +[loader developer home page](../../loader/devusage.md) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage/struct.md b/common/utils/DOC/loader/devusage/struct.md index b771f136d773d9074f5f00cb0b8ddc42bc03ba07..e3cfc74993b1f090573e0118ad7c330beafc46b8 100644 --- a/common/utils/DOC/loader/devusage/struct.md +++ b/common/utils/DOC/loader/devusage/struct.md @@ -6,5 +6,5 @@ It is defined in include file [ common/util/load_module_shlib.h ](https://gitlab | `fname` | symbol name, is passed to the [`dlsym`](http://man7.org/linux/man-pages/man3/dlsym.3.html) system call performed by the loader to get a pointer to the symbol | I | | `fptr` | pointer to the symbol name, set by the loader. `fptr` is defined as a `int (*fptr)(void)` function type | O | -[loader home page](loader) -[loader developer home page](loader/devusage) \ No newline at end of file +[loader home page](../..loader.md) +[loader developer home page](../devusage.md) \ No newline at end of file diff --git a/common/utils/DOC/loader/rtusage.md b/common/utils/DOC/loader/rtusage.md index cdd2883153a0a8e7f64bba4ef3f07ec420a76e23..e6b69f5e800ce9e4325beb1a676266365666dd46 100644 --- a/common/utils/DOC/loader/rtusage.md +++ b/common/utils/DOC/loader/rtusage.md @@ -6,7 +6,7 @@ Shared library full names are built by the loader using the format: 1. the < *module version* > and < *path* > optional parameters, are defined at run-time, depending on the configuration. ## loader parameters -The loader is using the [configuration module](config), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters. +The loader is using the [configuration module](../../../config/DOCconfig.md), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters. ### Global loader parameters | name | type | default | description | |:---:|:---:|:---:|:----| @@ -47,4 +47,4 @@ With this latest example, nn the softmodem logs, you can check that the right de ``` -[loader home page](loader) \ No newline at end of file +[loader home page](..loader.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetaddcmd.md b/common/utils/telnetsrv/DOC/telnetaddcmd.md index 9d23b6917f0397b335061d3e8e168c123f634809..ef5af3fb7ee34219d9d2d44c197cbcfe0a263824 100644 --- a/common/utils/telnetsrv/DOC/telnetaddcmd.md +++ b/common/utils/telnetsrv/DOC/telnetaddcmd.md @@ -92,7 +92,7 @@ int add_telnetcmd(char *modulename, telnetshell_vardef_t *var, telnetshell_cmdde Add a command and the `cmd` list of sub-commands to the telnet server. After a successful call to `add_telnetcmd` function, the telnet server calls the function defined for each sub-commands in the null terminated `cmd` array, when the character string received from the telnet client matches the command and sub-command strings. Also adds the list of variables described in the `var` array to the list of variable which can be set and read. The function returns -1 if one argument is NULL. -The telnet server is dynamically loaded, to use the `add_telnetcmd` function, the shared library loader API should be used to check the availability of the telnet server and retrieve it's address, as shown in [the example at the top of this page](telnetaddcmd#code-example-of-adding-a-command-to-the-telnet-server). +The telnet server is dynamically loaded, to use the `add_telnetcmd` function, the shared library loader API should be used to check the availability of the telnet server and retrieve it's address, as shown in [the example at the top of this page](telnetaddcmd.md#code-example-of-adding-a-command-to-the-telnet-server). # telnet server public data types ## `telnetshell_vardef_t`structure @@ -113,4 +113,4 @@ The telnet server is dynamically loaded, to use the `add_telnetcmd` function, t | `helpstr` | `char[TELNET_HELPSTR_SIZE]` | character string to print when the elp`command is received from the telnet client | | `cmdfunc` | `cmdfunc_t` | pointer to the function implementing the `cmdname` sub command. | -[oai telnet server home](telnetsrv) \ No newline at end of file +[oai telnet server home](telnetsrv.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetarch.md b/common/utils/telnetsrv/DOC/telnetarch.md index 579a7de967f4c8d6fe8af3796e94219b0e729495..f31a51b352b06bf98961d96fc97b0edf446fd3a5 100644 --- a/common/utils/telnetsrv/DOC/telnetarch.md +++ b/common/utils/telnetsrv/DOC/telnetarch.md @@ -18,4 +18,4 @@ telnet server source files are located in [common/utils/telnetsrv](https://gitla 1. `telnetsrv\_\.h`: include file for the implementation of XXX CLI command. Usually included only in the corresponding `.c`file 1. [telnetsrv_CMakeLists.txt](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/telnetsrv/telnetsrv_CMakeLists.txt): CMakelists file containing the cmake instructions to build the telnet server. this file is included in the [global oai CMakelists](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/cmake_targets/CMakeLists.txt). -[oai telnet server home](telnetsrv) \ No newline at end of file +[oai telnet server home](telnetsrv.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetgetset.md b/common/utils/telnetsrv/DOC/telnetgetset.md index ccf774a752ebd57e3e0bd838724ede1c2a7903af..e0b2c90d79cd787f3316611d2c7bc7d250b4e59b 100644 --- a/common/utils/telnetsrv/DOC/telnetgetset.md +++ b/common/utils/telnetsrv/DOC/telnetgetset.md @@ -17,5 +17,5 @@ telnet, loopc = 100 softmodem> ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnethelp.md b/common/utils/telnetsrv/DOC/telnethelp.md index ef614cae1c777fbf291b416157af858a5945a596..63183fb61189430149b6e4faac78f303090abd48 100644 --- a/common/utils/telnetsrv/DOC/telnethelp.md +++ b/common/utils/telnetsrv/DOC/telnethelp.md @@ -53,5 +53,5 @@ softmodem> ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnethist.md b/common/utils/telnetsrv/DOC/telnethist.md index 10682b8a85e1de79600bf5b7b392061b757efcb5..d938435a2405c474fc29ee6b2459f5843b7e5086 100644 --- a/common/utils/telnetsrv/DOC/telnethist.md +++ b/common/utils/telnetsrv/DOC/telnethist.md @@ -40,5 +40,5 @@ softmodem> ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetloader.md b/common/utils/telnetsrv/DOC/telnetloader.md index d64f0c6cdb3ec73ee128e75ab57db3f037d8211b..9250524989a67da5ea8a22108b3aeb7f86cd77a6 100644 --- a/common/utils/telnetsrv/DOC/telnetloader.md +++ b/common/utils/telnetsrv/DOC/telnetloader.md @@ -43,5 +43,5 @@ softmodem> loader show modules softmodem> ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetlog.md b/common/utils/telnetsrv/DOC/telnetlog.md index 00f09a3a6fb931aa2b31c835b2a0d21ba008b0d0..7c1d4f03840a772062aea56eb4f3ca6cfeab1736 100644 --- a/common/utils/telnetsrv/DOC/telnetlog.md +++ b/common/utils/telnetsrv/DOC/telnetlog.md @@ -1,4 +1,4 @@ -The log command can be used to get the status of the log parameters and to dynamically modify these parameters. The log command has its own [help](telnethelp#oai-telnet-server-specific-commands-help) +The log command can be used to get the status of the log parameters and to dynamically modify these parameters. The log command has its own [help](telnethelp.md#oai-telnet-server-specific-commands-help) ```bash softmodem> softmodem log disable 0-35 log level/verbosity comp 0 PHY set to info / medium (disabled) @@ -91,5 +91,5 @@ softmodem> exit Connection closed by foreign host. ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetloop.md b/common/utils/telnetsrv/DOC/telnetloop.md index 437481da68cb8203bae2efc665b05e4da883f150..f045e8a7161d150edad0b58f798f64e1ff2cf176 100644 --- a/common/utils/telnetsrv/DOC/telnetloop.md +++ b/common/utils/telnetsrv/DOC/telnetloop.md @@ -36,5 +36,5 @@ softmodem> loop softmodem show thread ``` A **_loop_** command can be interrupted by pressing the **_enter_** key till getting the prompt. -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetsrv.md b/common/utils/telnetsrv/DOC/telnetsrv.md index ab89da3f853146a98dc7ac2fd159c27fed792f52..e8909595d9e4c9770690958a119cbbd7de7cc662 100644 --- a/common/utils/telnetsrv/DOC/telnetsrv.md +++ b/common/utils/telnetsrv/DOC/telnetsrv.md @@ -4,4 +4,4 @@ The oai embedded telnet server is an optional monitoring and debugging tool. It * [Adding commands to the oai telnet server](telnetaddcmd.md) * [telnet server architecture ](telnetarch.md) -[oai Wikis home](home) \ No newline at end of file +[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home) \ No newline at end of file