From: Mattia Massarenti <mattiamassarenti.mm@gmail.com>
To: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org
Cc: Alexander Viro <viro@zeniv.linux.org.uk>,
Christian Brauner <brauner@kernel.org>, Jan Kara <jack@suse.cz>,
Mattia Massarenti <mattiamassarenti.mm@gmail.com>
Subject: [PATCH] add documentation for function parameter
Date: Sun, 31 Aug 2025 18:53:04 +0200 [thread overview]
Message-ID: <20250831165304.18435-1-mattiamassarenti.mm@gmail.com> (raw)
Add documentation for parameter 'name' in function 'name_contains_dotdot'
Signed-off-by: Mattia Massarenti <mattiamassarenti.mm@gmail.com>
---
1 | 3 +++
doc.log | 27 +++++++++++++++++++++++++++
include/linux/fs.h | 1 +
3 files changed, 31 insertions(+)
create mode 100644 1
create mode 100644 doc.log
diff --git a/1 b/1
new file mode 100644
index 000000000000..9e2cb3b10423
--- /dev/null
+++ b/1
@@ -0,0 +1,3 @@
+Command 'make' not found, but can be installed with:
+sudo apt install make # version 4.3-4.1build1, or
+sudo apt install make-guile # version 4.3-4.1build1
diff --git a/doc.log b/doc.log
new file mode 100644
index 000000000000..5af85cbcc86b
--- /dev/null
+++ b/doc.log
@@ -0,0 +1,27 @@
+ PARSE include/uapi/linux/dvb/ca.h
+ PARSE include/uapi/linux/dvb/dmx.h
+ PARSE include/uapi/linux/dvb/frontend.h
+ PARSE include/uapi/linux/dvb/net.h
+ PARSE include/uapi/linux/videodev2.h
+ PARSE include/uapi/linux/media.h
+ PARSE include/uapi/linux/cec.h
+ PARSE include/uapi/linux/lirc.h
+Using alabaster theme
+WARNING: dot(1) not found, for better output quality install graphviz from https://www.graphviz.org
+Using Python kernel-doc
+WARNING: ./include/linux/fs.h:3287 function parameter 'name' not described in 'name_contains_dotdot'
+WARNING: ./drivers/gpu/drm/amd/display/dc/dc.h:254 struct member 'num_rmcm_3dluts' not described in 'mpc_color_caps'
+/home/mattia/kernels/linux/Documentation/gpu/drm-kms:360: ./drivers/gpu/drm/drm_fourcc.c:397: WARNING: Duplicate C declaration, also defined at gpu/drm-kms:35.
+Declaration is '.. c:function:: const struct drm_format_info * drm_format_info (u32 format)'. [duplicate_declaration.c]
+/home/mattia/kernels/linux/Documentation/gpu/drm-kms:476: ./drivers/gpu/drm/drm_modeset_lock.c:377: WARNING: Duplicate C declaration, also defined at gpu/drm-kms:48.
+Declaration is '.. c:function:: int drm_modeset_lock (struct drm_modeset_lock *lock, struct drm_modeset_acquire_ctx *ctx)'. [duplicate_declaration.c]
+/home/mattia/kernels/linux/Documentation/gpu/drm-mm:506: ./drivers/gpu/drm/drm_gpuvm.c:2446: ERROR: Unexpected indentation. [docutils]
+/home/mattia/kernels/linux/Documentation/gpu/drm-mm:506: ./drivers/gpu/drm/drm_gpuvm.c:2448: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
+/home/mattia/kernels/linux/Documentation/gpu/drm-mm:506: ./drivers/gpu/drm/drm_gpuvm.c:2452: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
+/home/mattia/kernels/linux/Documentation/gpu/drm-mm:506: ./drivers/gpu/drm/drm_gpuvm.c:2453: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
+/home/mattia/kernels/linux/Documentation/gpu/drm-mm:506: ./drivers/gpu/drm/drm_gpuvm.c:2457: ERROR: Unexpected indentation. [docutils]
+/home/mattia/kernels/linux/Documentation/gpu/drm-mm:506: ./drivers/gpu/drm/drm_gpuvm.c:2458: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
+/home/mattia/kernels/linux/Documentation/gpu/drm-mm:506: ./drivers/gpu/drm/drm_gpuvm.c:2459: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
+/home/mattia/kernels/linux/Documentation/gpu/drm-mm:506: ./drivers/gpu/drm/drm_gpuvm.c:2460: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
+/home/mattia/kernels/linux/Documentation/gpu/drm-uapi:574: ./drivers/gpu/drm/drm_ioctl.c:915: WARNING: Duplicate C declaration, also defined at gpu/drm-uapi:69.
+Declaration is '.. c:function:: bool drm_ioctl_flags (unsigned int nr, unsigned int *flags)'. [duplicate_declaration.c]
diff --git a/include/linux/fs.h b/include/linux/fs.h
index d7ab4f96d705..a8272ca3306f 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -3281,6 +3281,7 @@ static inline bool is_dot_dotdot(const char *name, size_t len)
/**
* name_contains_dotdot - check if a file name contains ".." path components
+ * @name: file name to check
*
* Search for ".." surrounded by either '/' or start/end of string.
*/
--
2.43.0
next reply other threads:[~2025-08-31 16:53 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-31 16:53 Mattia Massarenti [this message]
[not found] ` <CAEMaYNJP_QWV9NkD9stdODfGgvZQX_yUBzqZQ5cr5-u_g9Tg2g@mail.gmail.com>
2025-09-03 5:41 ` Al Viro
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250831165304.18435-1-mattiamassarenti.mm@gmail.com \
--to=mattiamassarenti.mm@gmail.com \
--cc=brauner@kernel.org \
--cc=jack@suse.cz \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=viro@zeniv.linux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®