Document ioctls - Githubissues

kdave / btrfs-progs

Development of userspace BTRFS tools

GNU General Public License v2.0

544 stars 240 forks source link

Document ioctls #43

Open kdave opened 7 years ago

kdave commented 7 years ago

make list of all supported ioctls
annotate with versions
list used structures
enumerate constraints
possibly make short examples
refer to existing commands

The format should suit a manual page, the html output generated from asciidoc is usually ok.

knorrie commented 7 years ago

Nice idea! Feel free to steal ideas for examples or documentation text from the documentation I put into commit messages in python-btrfs, while implementing them. For example https://github.com/knorrie/python-btrfs/commit/0905e30bc249498764c3d46de6fc462e1eeb6335

kdave commented 7 years ago

Thanks, that would be a great source of course. The contents is one thing, I got stuck on the formatting side so that the output does not look totally ugly in the manual page output, preview in https://github.com/kdave/btrfs-progs/tree/doc/btrfs-ioctl

kdave commented 7 years ago

Setting the milestone to 4.14 was too optimistic. I've added the btrfs-ioctl page skeleton with some examples, so we can add the text incrementally.

kdave commented 1 year ago

Documentation/btrfs-ioctl.rst, basic structure is laid out with some examples.

kdave commented 11 months ago

https://btrfs.readthedocs.io/en/latest/btrfs-ioctl.html ioctls are incrementally added, the basic structure is now more or less done so adding new ones should be easy. Any help welcome.