does this sort of patch fall under the mandate of linux-doc?

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



  for the purposes of writing some courseware, i'd like -- as much as
possible -- to just grab chunks of header files and have them be
self-documenting.  so i'd be interested in occasionally submitting
patches like the following:

=====

diff --git a/include/linux/fs.h b/include/linux/fs.h
index aa11047..7019cc3 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -2301,14 +2301,15 @@ static inline void bd_unlink_disk_holder(struct block_device *bdev,

 /* fs/char_dev.c */
 #define CHRDEV_MAJOR_HASH_SIZE	255
-extern int alloc_chrdev_region(dev_t *, unsigned, unsigned, const char *);
-extern int register_chrdev_region(dev_t, unsigned, const char *);
+extern int alloc_chrdev_region(dev_t *, unsigned baseminor,
+			       unsigned count, const char *name);
+extern int register_chrdev_region(dev_t, unsigned count, const char *name);
 extern int __register_chrdev(unsigned int major, unsigned int baseminor,
 			     unsigned int count, const char *name,
 			     const struct file_operations *fops);
 extern void __unregister_chrdev(unsigned int major, unsigned int baseminor,
 				unsigned int count, const char *name);
-extern void unregister_chrdev_region(dev_t, unsigned);
+extern void unregister_chrdev_region(dev_t, unsigned count);
 extern void chrdev_show(struct seq_file *,off_t);

 static inline int register_chrdev(unsigned int major, const char *name,

=====

  obviously, patches like that represent no actual functional change,
it just makes it clearer what the parameters represent if someone is
reading the header file.  and that's already *partly* done in that
very header file, it's just not consistent.

  would something like that be a change appropriate for this list?
i'm not going to try to do massive changes all at once, just logical
changes as i run across stuff that i would find useful to be more
self-documenting.

  thoughts?

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux