Skip to content

Commit e5b1c0f

Browse files
pevikJonathan Corbet
authored andcommitted
Documentation: Remove :manpage: from non-existing man pages
Removing :manpage: from non-existing man pages (xyzzy(2), xyzzyat(2), fxyzzy(3) in adding-syscalls.rst, including translations) prevent adding link to nonexisting man pages when using manpages_url in next commit. While at it, add also missing '(2)' in sp_SP translation. Reviewed-by: Alejandro Colomar <alx@kernel.org> Signed-off-by: Petr Vorel <pvorel@suse.cz> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260113113612.315748-2-pvorel@suse.cz>
1 parent 07265c3 commit e5b1c0f

3 files changed

Lines changed: 24 additions & 24 deletions

File tree

Documentation/process/adding-syscalls.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ should use a file descriptor as the handle for that object -- don't invent a
111111
new type of userspace object handle when the kernel already has mechanisms and
112112
well-defined semantics for using file descriptors.
113113

114-
If your new :manpage:`xyzzy(2)` system call does return a new file descriptor,
114+
If your new xyzzy(2) system call does return a new file descriptor,
115115
then the flags argument should include a value that is equivalent to setting
116116
``O_CLOEXEC`` on the new FD. This makes it possible for userspace to close
117117
the timing window between ``xyzzy()`` and calling
@@ -127,18 +127,18 @@ descriptor. Making a file descriptor ready for reading or writing is the
127127
normal way for the kernel to indicate to userspace that an event has
128128
occurred on the corresponding kernel object.
129129

130-
If your new :manpage:`xyzzy(2)` system call involves a filename argument::
130+
If your new xyzzy(2) system call involves a filename argument::
131131

132132
int sys_xyzzy(const char __user *path, ..., unsigned int flags);
133133

134-
you should also consider whether an :manpage:`xyzzyat(2)` version is more appropriate::
134+
you should also consider whether an xyzzyat(2) version is more appropriate::
135135

136136
int sys_xyzzyat(int dfd, const char __user *path, ..., unsigned int flags);
137137

138138
This allows more flexibility for how userspace specifies the file in question;
139139
in particular it allows userspace to request the functionality for an
140140
already-opened file descriptor using the ``AT_EMPTY_PATH`` flag, effectively
141-
giving an :manpage:`fxyzzy(3)` operation for free::
141+
giving an fxyzzy(3) operation for free::
142142

143143
- xyzzyat(AT_FDCWD, path, ..., 0) is equivalent to xyzzy(path,...)
144144
- xyzzyat(fd, "", ..., AT_EMPTY_PATH) is equivalent to fxyzzy(fd, ...)
@@ -147,11 +147,11 @@ giving an :manpage:`fxyzzy(3)` operation for free::
147147
:manpage:`openat(2)` man page; for an example of AT_EMPTY_PATH, see the
148148
:manpage:`fstatat(2)` man page.)
149149

150-
If your new :manpage:`xyzzy(2)` system call involves a parameter describing an
150+
If your new xyzzy(2) system call involves a parameter describing an
151151
offset within a file, make its type ``loff_t`` so that 64-bit offsets can be
152152
supported even on 32-bit architectures.
153153

154-
If your new :manpage:`xyzzy(2)` system call involves privileged functionality,
154+
If your new xyzzy(2) system call involves privileged functionality,
155155
it needs to be governed by the appropriate Linux capability bit (checked with
156156
a call to ``capable()``), as described in the :manpage:`capabilities(7)` man
157157
page. Choose an existing capability bit that governs related functionality,
@@ -160,7 +160,7 @@ under the same bit, as this goes against capabilities' purpose of splitting
160160
the power of root. In particular, avoid adding new uses of the already
161161
overly-general ``CAP_SYS_ADMIN`` capability.
162162

163-
If your new :manpage:`xyzzy(2)` system call manipulates a process other than
163+
If your new xyzzy(2) system call manipulates a process other than
164164
the calling process, it should be restricted (using a call to
165165
``ptrace_may_access()``) so that only a calling process with the same
166166
permissions as the target process, or with the necessary capabilities, can
@@ -196,7 +196,7 @@ be cc'ed to linux-api@vger.kernel.org.
196196
Generic System Call Implementation
197197
----------------------------------
198198

199-
The main entry point for your new :manpage:`xyzzy(2)` system call will be called
199+
The main entry point for your new xyzzy(2) system call will be called
200200
``sys_xyzzy()``, but you add this entry point with the appropriate
201201
``SYSCALL_DEFINEn()`` macro rather than explicitly. The 'n' indicates the
202202
number of arguments to the system call, and the macro takes the system call name

Documentation/translations/it_IT/process/adding-syscalls.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ descrittore di file per accesso all'oggetto - non inventatevi nuovi tipi di
124124
accesso da spazio utente quando il kernel ha già dei meccanismi e una semantica
125125
ben definita per utilizzare i descrittori di file.
126126

127-
Se la vostra nuova chiamata di sistema :manpage:`xyzzy(2)` ritorna un nuovo
127+
Se la vostra nuova chiamata di sistema xyzzy(2) ritorna un nuovo
128128
descrittore di file, allora l'argomento *flags* dovrebbe includere un valore
129129
equivalente a ``O_CLOEXEC`` per i nuovi descrittori. Questo rende possibile,
130130
nello spazio utente, la chiusura della finestra temporale fra le chiamate a
@@ -140,21 +140,21 @@ della famiglia di :manpage:`poll(2)`. Rendere un descrittore di file pronto
140140
per la lettura o la scrittura è il tipico modo del kernel per notificare lo
141141
spazio utente circa un evento associato all'oggetto del kernel.
142142

143-
Se la vostra nuova chiamata di sistema :manpage:`xyzzy(2)` ha un argomento
143+
Se la vostra nuova chiamata di sistema xyzzy(2) ha un argomento
144144
che è il percorso ad un file::
145145

146146
int sys_xyzzy(const char __user *path, ..., unsigned int flags);
147147

148148
dovreste anche considerare se non sia più appropriata una versione
149-
:manpage:`xyzzyat(2)`::
149+
`xyzzyat(2)`::
150150

151151
int sys_xyzzyat(int dfd, const char __user *path, ..., unsigned int flags);
152152

153153
Questo permette più flessibilità su come lo spazio utente specificherà il file
154154
in questione; in particolare, permette allo spazio utente di richiedere la
155155
funzionalità su un descrittore di file già aperto utilizzando il *flag*
156156
``AT_EMPTY_PATH``, in pratica otterremmo gratuitamente l'operazione
157-
:manpage:`fxyzzy(3)`::
157+
fxyzzy(3)::
158158

159159
- xyzzyat(AT_FDCWD, path, ..., 0) is equivalent to xyzzy(path,...)
160160
- xyzzyat(fd, "", ..., AT_EMPTY_PATH) is equivalent to fxyzzy(fd, ...)
@@ -163,12 +163,12 @@ funzionalità su un descrittore di file già aperto utilizzando il *flag*
163163
man :manpage:`openat(2)`; per un esempio di AT_EMPTY_PATH, leggere la pagina
164164
man :manpage:`fstatat(2)`).
165165

166-
Se la vostra nuova chiamata di sistema :manpage:`xyzzy(2)` prevede un parametro
166+
Se la vostra nuova chiamata di sistema xyzzy(2) prevede un parametro
167167
per descrivere uno scostamento all'interno di un file, usate ``loff_t`` come
168168
tipo cosicché scostamenti a 64-bit potranno essere supportati anche su
169169
architetture a 32-bit.
170170

171-
Se la vostra nuova chiamata di sistema :manpage:`xyzzy(2)` prevede l'uso di
171+
Se la vostra nuova chiamata di sistema xyzzy(2) prevede l'uso di
172172
funzioni riservate, allora dev'essere gestita da un opportuno bit di privilegio
173173
(verificato con una chiamata a ``capable()``), come descritto nella pagina man
174174
:manpage:`capabilities(7)`. Scegliete un bit di privilegio già esistente per
@@ -178,7 +178,7 @@ principio di *capabilities* di separare i poteri di root. In particolare,
178178
evitate di aggiungere nuovi usi al fin-troppo-generico privilegio
179179
``CAP_SYS_ADMIN``.
180180

181-
Se la vostra nuova chiamata di sistema :manpage:`xyzzy(2)` manipola altri
181+
Se la vostra nuova chiamata di sistema xyzzy(2) manipola altri
182182
processi oltre a quello chiamato, allora dovrebbe essere limitata (usando
183183
la chiamata ``ptrace_may_access()``) di modo che solo un processo chiamante
184184
con gli stessi permessi del processo in oggetto, o con i necessari privilegi,
@@ -219,7 +219,7 @@ Implementazione di chiamate di sistema generiche
219219
------------------------------------------------
220220

221221
Il principale punto d'accesso alla vostra nuova chiamata di sistema
222-
:manpage:`xyzzy(2)` verrà chiamato ``sys_xyzzy()``; ma, piuttosto che in modo
222+
`xyzzy(2)` verrà chiamato ``sys_xyzzy()``; ma, piuttosto che in modo
223223
esplicito, lo aggiungerete tramite la macro ``SYSCALL_DEFINEn``. La 'n'
224224
indica il numero di argomenti della chiamata di sistema; la macro ha come
225225
argomento il nome della chiamata di sistema, seguito dalle coppie (tipo, nome)

Documentation/translations/sp_SP/process/adding-syscalls.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ manipulador de ese objeto -- no invente un nuevo tipo de objeto manipulador
128128
userspace cuando el kernel ya tiene mecanismos y semánticas bien definidas
129129
para usar los descriptores de archivos.
130130

131-
Si su nueva llamada a sistema :manpage:`xyzzy(2)` retorna un nuevo
131+
Si su nueva llamada a sistema xyzzy(2) retorna un nuevo
132132
descriptor de archivo, entonces el argumento flag debe incluir un valor que
133133
sea equivalente a definir ``O_CLOEXEC`` en el nuevo FD. Esto hace posible
134134
al userspace acortar la brecha de tiempo entre ``xyzzy()`` y la llamada a
@@ -145,20 +145,20 @@ archivo listo para leer o escribir es la forma normal para que el kernel
145145
indique al espacio de usuario que un evento ha ocurrido en el
146146
correspondiente objeto del kernel.
147147

148-
Si su nueva llamada de sistema :manpage:`xyzzy(2)` involucra algún nombre
148+
Si su nueva llamada de sistema xyzzy(2) involucra algún nombre
149149
de archivo como argumento::
150150

151151
int sys_xyzzy(const char __user *path, ..., unsigned int flags);
152152

153-
debería considerar también si una versión :manpage:`xyzzyat(2)` es mas
153+
debería considerar también si una versión xyzzyat(2) es mas
154154
apropiada::
155155

156156
int sys_xyzzyat(int dfd, const char __user *path, ..., unsigned int flags);
157157

158158
Esto permite más flexibilidad en como el userspace especifica el archivo en
159159
cuestión; en particular esto permite al userspace pedir la funcionalidad a
160160
un descriptor de archivo ya abierto usando el flag ``AT_EMPTY_PATH``,
161-
efectivamente dando una operación :manpage:`fxyzzy(3)` gratis::
161+
efectivamente dando una operación fxyzzy(3) gratis::
162162

163163
- xyzzyat(AT_FDCWD, path, ..., 0) es equivalente a xyzzy(path, ...)
164164
- xyzzyat(fd, "", ..., AT_EMPTY_PATH) es equivalente a fxyzzy(fd, ...)
@@ -167,12 +167,12 @@ efectivamente dando una operación :manpage:`fxyzzy(3)` gratis::
167167
revise el man page :manpage:`openat(2)`; para un ejemplo de AT_EMPTY_PATH,
168168
mire el man page :manpage:`fstatat(2)` manpage.)
169169

170-
Si su nueva llamada de sistema :manpage:`xyzzy(2)` involucra un parámetro
170+
Si su nueva llamada de sistema xyzzy(2) involucra un parámetro
171171
describiendo un describiendo un movimiento dentro de un archivo, ponga de
172172
tipo ``loff_t`` para que movimientos de 64-bit puedan ser soportados
173173
incluso en arquitecturas de 32-bit.
174174

175-
Si su nueva llamada de sistema :manpage:`xyzzy` involucra una
175+
Si su nueva llamada de sistema xyzzy(2) involucra una
176176
funcionalidad privilegiada, esta necesita ser gobernada por la capability
177177
bit linux apropiada (revisado con una llamada a ``capable()``), como se
178178
describe en el man page :manpage:`capabilities(7)`. Elija una parte de
@@ -182,7 +182,7 @@ misma sección, ya que va en contra de los propósitos de las capabilities de
182182
dividir el poder del usuario root. En particular, evite agregar nuevos usos
183183
de la capacidad ya demasiado general de la capabilities ``CAP_SYS_ADMIN``.
184184

185-
Si su nueva llamada de sistema :manpage:`xyzzy(2)` manipula un proceso que
185+
Si su nueva llamada de sistema xyzzy(2) manipula un proceso que
186186
no es el proceso invocado, este debería ser restringido (usando una llamada
187187
a ``ptrace_may_access()``) de forma que el único proceso con los mismos
188188
permisos del proceso objetivo, o con las capacidades (capabilities)
@@ -221,7 +221,7 @@ kernel, debería siempre ser copiado a linux-api@vger.kernel.org.
221221
Implementation de Llamada de Sistema Generica
222222
---------------------------------------------
223223

224-
La entrada principal a su nueva llamada de sistema :manpage:`xyzzy(2)` será
224+
La entrada principal a su nueva llamada de sistema xyzzy(2) será
225225
llamada ``sys_xyzzy()``, pero incluya este punto de entrada con la macro
226226
``SYSCALL_DEFINEn()`` apropiada en vez de explicitamente. El 'n' indica el
227227
numero de argumentos de la llamada de sistema, y la macro toma el nombre de

0 commit comments

Comments
 (0)