Skip to content

Commit f712c27

Browse files
dwsuseigaw
authored andcommitted
doc: Do not hardcode default location for config files
The location of the config files is depending of the configuration. Because we ship pre-compiled documentation the SYSCONFDIR might not be correct. Avoid confusion and just point out they live under SYSCONFDIR. Signed-off-by: Daniel Wagner <[email protected]>
1 parent 5402fa6 commit f712c27

2 files changed

Lines changed: 13 additions & 12 deletions

File tree

doc/meson.build

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,32 +53,25 @@ test('kdoc', kernel_doc_check, args: api_paths)
5353

5454
if want_docs != 'false'
5555

56-
conf = configuration_data()
57-
conf.set('SYSCONFDIR', sysconfdir)
58-
5956
if want_docs == 'all' or want_docs == 'man'
6057
mandir = join_paths(get_option('mandir'), 'man2')
6158
list_man_pages = find_program('list-man-pages.sh')
6259
if want_docs_build
6360
foreach apif : api_paths
64-
subst = configure_file(
65-
input: apif,
66-
output: '@[email protected]',
67-
configuration: conf)
68-
c = run_command(list_man_pages, subst, check: true)
61+
c = run_command(list_man_pages, apif, check: true)
6962
man_pages = c.stdout().split()
7063
foreach page : man_pages
7164
custom_target(
7265
page.underscorify() + '_man',
73-
input: subst,
66+
input: apif,
7467
output: page + '.2',
7568
capture: true,
7669
command: [kernel_doc,
7770
'-module', 'libnvme',
7871
'-man',
7972
'-function',
8073
page,
81-
subst],
74+
apif],
8275
install: true,
8376
install_dir: mandir)
8477
endforeach

src/nvme/fabrics.h

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,15 +257,23 @@ char *nvmf_hostnqn_generate();
257257

258258
/**
259259
* nvmf_hostnqn_from_file() - Reads the host nvm qualified name from the config
260-
* default location in @SYSCONFDIR@/nvme/
260+
* default location
261+
*
262+
* Retrieve the qualified name from the config file located in $SYSCONFIDR/nvme.
263+
* $SYSCONFDIR is usually /etc.
264+
*
261265
* Return: The host nqn, or NULL if unsuccessful. If found, the caller
262266
* is responsible to free the string.
263267
*/
264268
char *nvmf_hostnqn_from_file();
265269

266270
/**
267271
* nvmf_hostid_from_file() - Reads the host identifier from the config default
268-
* location in @SYSCONFDIR@/nvme/.
272+
* location
273+
*
274+
* Retrieve the host idenditifer from the config file located in $SYSCONFDIR/nvme/.
275+
* $SYSCONFDIR is usually /etc.
276+
*
269277
* Return: The host identifier, or NULL if unsuccessful. If found, the caller
270278
* is responsible to free the string.
271279
*/

0 commit comments

Comments
 (0)