btrfs-progs icon indicating copy to clipboard operation
btrfs-progs copied to clipboard

Document ioctls

Open kdave opened this issue 8 years ago • 5 comments

  • 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.

kdave avatar May 03 '17 14:05 kdave

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

knorrie avatar Sep 08 '17 21:09 knorrie

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 avatar Sep 11 '17 18:09 kdave

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 avatar Sep 15 '17 15:09 kdave

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

kdave avatar Sep 21 '22 07:09 kdave

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.

kdave avatar Oct 17 '23 17:10 kdave