Skip to content
This repository was archived by the owner on Feb 16, 2026. It is now read-only.

Commit d9ccdb7

Browse files
committed
Doc-fixino for vcl.label
1 parent 67ea0c8 commit d9ccdb7

3 files changed

Lines changed: 11 additions & 5 deletions

File tree

bin/varnishd/mgt/mgt_cli.c

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -690,14 +690,18 @@ void
690690
mgt_DumpRstCli(void)
691691
{
692692
const struct cli_cmd_desc *cp;
693+
const char *p;
693694
int i, j;
694695

695696
qsort(cmds, ncmds, sizeof cmds[0], cli_cmp);
696697
for (i = 0; i < ncmds; i++, cp++) {
697698
cp = cmds[i];
698699
if (!strncmp(cp->request, "debug.", 6))
699700
continue;
700-
printf(".. _ref_cli_%s:\n\n", cp->syntax);
701+
printf(".. _ref_cli_");
702+
for (p = cp->request; *p; p++)
703+
putchar(*p == '.' ? '_' : *p);
704+
printf(":\n\n");
701705
printf("%s\n", cp->syntax);
702706
for (j = 0; j < strlen(cp->syntax); j++)
703707
printf("~");

doc/sphinx/users-guide/vcl-built-in-subs.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ of the following keywords:
110110
Switch to vcl labelled *label*. This will continue vcl processing
111111
in this vcl's :ref:`vcl_recv` as if it was the active vcl.
112112

113-
See the :ref:`varnishadm(1)` ``vcl.label`` command.
113+
See the :ref:`ref_cli_vcl_label` command.
114114

115115
.. _vcl_pipe:
116116

@@ -537,8 +537,8 @@ with one of the following keywords:
537537
:ref:`vcl_synth` on the client side is called with ``resp.status``
538538
preset to 503.
539539

540-
vcl.load / vcl.discard
541-
----------------------
540+
During vcl.load / vcl.discard
541+
-----------------------------
542542

543543
.. _vcl_init:
544544

include/tbl/cli_cmds.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,9 @@ CLI_CMD(VCL_LABEL,
141141
"vcl.label",
142142
"vcl.label <label> <configname>",
143143
"Apply label to configuration.",
144-
"",
144+
"A VCL label is like a UNIX symbolic link, "
145+
"a name without substance, which points to another VCL.\n\n"
146+
"Labels are mandatory whenever one VCL references another.",
145147
2, 2
146148
)
147149

0 commit comments

Comments
 (0)