From mboxrd@z Thu Jan 1 00:00:00 1970 From: David Drysdale Subject: [PATCHv3 0/1] Document how to add a new syscall Date: Fri, 31 Jul 2015 15:35:45 +0100 Message-ID: <1438353346-67177-1-git-send-email-drysdale@google.com> Return-path: Sender: linux-doc-owner@vger.kernel.org To: linux-api@vger.kernel.org, Michael Kerrisk , Andrew Morton , Arnd Bergmann , Shuah Khan , Jonathan Corbet , Eric B Munson , Randy Dunlap , Cyril Hrubis , Josh Triplett Cc: Andrea Arcangeli , Thomas Gleixner , Ingo Molnar , "H. Peter Anvin" , Oleg Nesterov , Linus Torvalds , Greg Kroah-Hartman , Andy Lutomirski , Al Viro , Rusty Russell , Peter Zijlstra , Vivek Goyal , Alexei Starovoitov , David Herrmann , Theodore Ts'o , Kees Cook , Milosz Tanski , Fam Zheng , Mathieu Desnoyers , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, David Drysdale List-Id: linux-api@vger.kernel.org [Admin note: I'm on vacation next week, so I'll collate any additional feedback when I get back.] Given that I've gotten some of the details wrong in the past (and I've seen others do likewise), I thought it might be helpful to collate the best practices for adding a new system call to the kernel. Apologies for the wide circulation -- I've tried to include folk who've recently added or proposed a system call, as they're most likely to have opinions on: - whether this a useful addition to Documentation/ - whether the details of the advice are correct and complete. Thanks, David (With thanks to Andrew Morton for looking over an initial draft, and to Michael Kerrisk for suggesting several clarifications and additions.) Changes since v2: - add struct-with-size as option for extensibility [Ingo Molnar] - mention LTP and xfstests [Cyril Hrubis] - always use file descriptors as handles for kernel objects [Josh Triplett] - consider poll(2) semantics for new file descriptors [Josh Triplett] - use a CONFIG option to control new functionality [Josh Triplett] - check ptrace_may_access() for process manipulation [Josh Triplett] - various minor markups [Josh Triplett] Changes since v1: - added paragraph on build requirements to Testing section [Shuah Khan, Peter Zijlstra] - various text clarifications [Kees Cook] - added Reviewed-by markers David Drysdale (1): Documentation: describe how to add a system call Documentation/adding-syscalls.txt | 531 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 531 insertions(+) create mode 100644 Documentation/adding-syscalls.txt -- 2.2.0.rc0.207.ga3a616c