[<prev] [next>] [day] [month] [year] [list]
Message-ID: <20250831165304.18435-1-mattiamassarenti.mm@gmail.com>
Date: Sun, 31 Aug 2025 18:53:04 +0200
From: Mattia Massarenti <mattiamassarenti.mm@...il.com>
To: linux-kernel@...r.kernel.org,
linux-fsdevel@...r.kernel.org
Cc: Alexander Viro <viro@...iv.linux.org.uk>,
Christian Brauner <brauner@...nel.org>,
Jan Kara <jack@...e.cz>,
Mattia Massarenti <mattiamassarenti.mm@...il.com>
Subject: [PATCH] add documentation for function parameter
Add documentation for parameter 'name' in function 'name_contains_dotdot'
Signed-off-by: Mattia Massarenti <mattiamassarenti.mm@...il.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
Powered by blists - more mailing lists