diff options
| author | Kari Argillander <kari.argillander@gmail.com> | 2021-08-03 14:57:09 +0300 |
|---|---|---|
| committer | Konstantin Komarov <almaz.alexandrovich@paragon-software.com> | 2021-08-30 18:39:14 +0300 |
| commit | e8b8e97f91b80f08a2f1b7ea4f81e7af61b2cc2f (patch) | |
| tree | dfa9cd09534c9d3f495a4bd5c36fd182856810be /fs/ntfs3/debug.h | |
| parent | b8155e95de38b25a69dfb03e4731fd6c5a28531e (diff) | |
| download | linux-e8b8e97f91b80f08a2f1b7ea4f81e7af61b2cc2f.tar.xz | |
fs/ntfs3: Restyle comments to better align with kernel-doc
Capitalize comments and end with period for better reading.
Also function comments are now little more kernel-doc style. This way we
can easily convert them to kernel-doc style if we want. Note that these
are not yet complete with this style. Example function comments start
with /* and in kernel-doc style they start /**.
Use imperative mood in function descriptions.
Change words like ntfs -> NTFS, linux -> Linux.
Use "we" not "I" when commenting code.
Signed-off-by: Kari Argillander <kari.argillander@gmail.com>
Signed-off-by: Konstantin Komarov <almaz.alexandrovich@paragon-software.com>
Diffstat (limited to 'fs/ntfs3/debug.h')
| -rw-r--r-- | fs/ntfs3/debug.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/fs/ntfs3/debug.h b/fs/ntfs3/debug.h index c8403e876b2d..31120569a87b 100644 --- a/fs/ntfs3/debug.h +++ b/fs/ntfs3/debug.h @@ -3,7 +3,8 @@ * * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved. * - * useful functions for debugging + * Useful functions for debugging. + * */ // clang-format off @@ -33,7 +34,7 @@ void ntfs_inode_printk(struct inode *inode, const char *fmt, ...) #endif /* - * Logging macros ( thanks Joe Perches <joe@perches.com> for implementation ) + * Logging macros. Thanks Joe Perches <joe@perches.com> for implementation. */ #define ntfs_err(sb, fmt, ...) ntfs_printk(sb, KERN_ERR fmt, ##__VA_ARGS__) |