Hi, While doing some .txt conversions to .rst, I ended up with several questions about markup style, and in looking at existing .rst files, there didn't seem to be a common methodology. I'd love to have definitive guide to how to do these things in the kernel documentation: - how to mark and link to CONFIG items? (e.g. CONFIG_HARDENED_USERCOPY) - how to mark and link to kernel command line arguments? (e.g. loadpin.enabled=1) - how to mark and link to functions? (e.g. put_seccomp()) - how to mark and link to fields? (e.g. siginfo->si_arch) - how to mark and link to defines/literals? (e.g PR_SET_NO_NEW_PRIVS) - how to mark and link to sysctls? (e.g. net.syn_cookies) - how to mark and link to manpage-look-up-able things? (e.g. setuid(2)) - how to mark internal filepaths? (e.g. samples/seccomp/) - how to mark external filepaths? (e.g. /etc/passwd) - how to mark environment variables (e.g. LD_*) It seems most aren't explicitly marked up in existing docs. Sometimes functions are wrapped in `` marks, same for pathnames. Any opinions would be appreciated. :) -- Kees Cook Pixel Security -- 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
