From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753010AbdLSVRc (ORCPT ); Tue, 19 Dec 2017 16:17:32 -0500 Received: from out3-smtp.messagingengine.com ([66.111.4.27]:59801 "EHLO out3-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751013AbdLSVR2 (ORCPT ); Tue, 19 Dec 2017 16:17:28 -0500 X-ME-Sender: From: "Tobin C. Harding" To: Jonathan Corbet Cc: "Tobin C. Harding" , Randy Dunlap , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Kees Cook , Alexander Popov , Joe Perches , kernel-hardening@lists.openwall.com Subject: [PATCH v4 0/3] doc: update printk documentation Date: Wed, 20 Dec 2017 08:17:14 +1100 Message-Id: <1513718237-24140-1-git-send-email-me@tobin.cc> X-Mailer: git-send-email 2.7.4 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This set converts printk-formats.txt -> core-api/printk-formats.rst We also update the documentation around printing kernel addresses. This is my first documentation conversion. Please do be hard on this patch series. I'd like to get it _really_ correct so that future conversions will require less review effort. Also if there are any peculiarities to patching docs (as apposed to C files) please say so. Thank you for the time already given to reviewing previous versions. thanks, Tobin. v4: - fix typo 'kpt_restrict' -> 'kptr_restrict' (thanks Randy). v3: - Update filename .txt -> .rst in lib/vsnprintf.c comment (Joe Perches) - Remove unnecessary commas (as suggested by Randy Dunlap) - Re-apply theory 'make as few changes as possible to complete the conversion' v2: - Remove conversion/inclusion of kernel-docs from lib/vsprintf.c - Add '<>' around file name (in section 'Thanks'). - Remove a few more double back ticks. - Apply theory 'make as few changes as possible to complete the conversion' Tobin C. Harding (3): doc: convert printk-formats.txt to rst doc: update kptr_restrict documentation doc: add documentation on printing kernel addresses Documentation/00-INDEX | 2 - Documentation/core-api/index.rst | 1 + .../printk-formats.rst} | 229 +++++++++++---------- Documentation/security/self-protection.rst | 15 ++ Documentation/sysctl/kernel.txt | 3 +- lib/vsprintf.c | 3 +- 6 files changed, 139 insertions(+), 114 deletions(-) rename Documentation/{printk-formats.txt => core-api/printk-formats.rst} (63%) -- 2.7.4