From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1765126AbcINXGY (ORCPT ); Wed, 14 Sep 2016 19:06:24 -0400 Received: from bombadil.infradead.org ([198.137.202.9]:46967 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1764477AbcINXGR (ORCPT ); Wed, 14 Sep 2016 19:06:17 -0400 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , Jonathan Corbet , Mauro Carvalho Chehab , Alex Henrie , Jakub Wilk , Chris Metcalf , Darren Hart , Eddie Kovsky , Luis de Bethencourt , Markus Heiser , Jani Nikula , LKML Subject: [PATCH 11/17] SubmittingPatches.rst: Add some cross-references Date: Wed, 14 Sep 2016 20:05:56 -0300 Message-Id: X-Mailer: git-send-email 2.7.4 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This file mentions some other documents already converted to ReST format. Add cross-references for them. Signed-off-by: Mauro Carvalho Chehab --- .../development-process/SubmitChecklist.rst | 2 ++ .../development-process/SubmittingPatches.rst | 24 ++++++++++++++-------- .../development-process/development-process.rst | 2 ++ .../development-process/email-clients.rst | 2 ++ 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/Documentation/development-process/SubmitChecklist.rst b/Documentation/development-process/SubmitChecklist.rst index 71ad93ffd9d6..6845a4e4d96e 100644 --- a/Documentation/development-process/SubmitChecklist.rst +++ b/Documentation/development-process/SubmitChecklist.rst @@ -1,3 +1,5 @@ +.. _submitchecklist: + Linux Kernel patch submission checklist ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/Documentation/development-process/SubmittingPatches.rst b/Documentation/development-process/SubmittingPatches.rst index b1fbdf501168..ef3cb81de59b 100644 --- a/Documentation/development-process/SubmittingPatches.rst +++ b/Documentation/development-process/SubmittingPatches.rst @@ -10,10 +10,12 @@ can greatly increase the chances of your change being accepted. This document contains a large number of suggestions in a relatively terse format. For detailed information on how the kernel development process -works, see Documentation/development-process. Also, read -Documentation/SubmitChecklist for a list of items to check before +works, see :ref:`Documentation/development-process `. +Also, read :ref:`Documentation/development-process/SubmitChecklist.rst ` +for a list of items to check before submitting code. If you are submitting a driver, also read -Documentation/development-process/SubmittingDrivers.rst; for device tree binding patches, read +:ref:`Documentation/development-process/SubmittingDrivers.rst `; +for device tree binding patches, read Documentation/devicetree/bindings/submitting-patches.txt. Many of these steps describe the default behavior of the git version @@ -246,7 +248,9 @@ Style-check your changes ------------------------ Check your patch for basic style violations, details of which can be -found in Documentation/development-process/CodingStyle.rst. Failure to do so simply wastes +found in +:ref:`Documentation/development-process/CodingStyle.rst `. +Failure to do so simply wastes the reviewers time and will get your patch rejected, probably without even being read. @@ -313,8 +317,9 @@ toward the stable maintainers by putting a line like this: Cc: stable@vger.kernel.org into the sign-off area of your patch (note, NOT an email recipient). You -should also read Documentation/development-process/stable_kernel_rules.rst in addition to this -file. +should also read +:ref:`Documentation/development-process/stable_kernel_rules.rst ` +in addition to this file. Note, however, that some subsystem maintainers want to come to their own conclusions on which patches should go to the stable trees. The networking @@ -368,8 +373,9 @@ decreasing the likelihood of your MIME-attached change being accepted. Exception: If your mailer is mangling patches then someone may ask you to re-send them using MIME. -See Documentation/development-process/email-clients.rst for hints about configuring -your e-mail client so that it sends your patches untouched. +See :ref:`Documentation/development-process/email-clients.rst ` +for hints about configuring your e-mail client so that it sends your patches +untouched. E-mail size ----------- @@ -844,7 +850,7 @@ NO!!!! No more huge patch bombs to linux-kernel@vger.kernel.org people! Kernel Documentation/development-process/CodingStyle.rst: - + :ref:`Documentation/development-process/CodingStyle.rst ` Linus Torvalds's mail on the canonical patch format: diff --git a/Documentation/development-process/development-process.rst b/Documentation/development-process/development-process.rst index d431a1098875..bd1399f7202a 100644 --- a/Documentation/development-process/development-process.rst +++ b/Documentation/development-process/development-process.rst @@ -1,3 +1,5 @@ +.. _development_process_main: + A guide to the Kernel Development Process ========================================= diff --git a/Documentation/development-process/email-clients.rst b/Documentation/development-process/email-clients.rst index 0deb240bee56..d35f5fd05f29 100644 --- a/Documentation/development-process/email-clients.rst +++ b/Documentation/development-process/email-clients.rst @@ -1,3 +1,5 @@ +.. _email_clients: + Email clients info for Linux ============================ -- 2.7.4