From patchwork Wed Sep 14 23:05:52 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 9332687 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 668626077A for ; Wed, 14 Sep 2016 23:11:05 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 516F628D0A for ; Wed, 14 Sep 2016 23:11:05 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 4573B28D0F; Wed, 14 Sep 2016 23:11:05 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 8432D28D0A for ; Wed, 14 Sep 2016 23:11:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1762286AbcINXJW (ORCPT ); Wed, 14 Sep 2016 19:09:22 -0400 Received: from bombadil.infradead.org ([198.137.202.9]:46943 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1763711AbcINXGL (ORCPT ); Wed, 14 Sep 2016 19:06:11 -0400 Received: from 177.17.173.60.dynamic.adsl.gvt.net.br ([177.17.173.60] helo=smtp.w2.samsung.com) by bombadil.infradead.org with esmtpsa (Exim 4.85_2 #1 (Red Hat Linux)) id 1bkJFp-00046y-9I; Wed, 14 Sep 2016 23:06:09 +0000 Received: from mchehab by smtp.w2.samsung.com with local (Exim 4.87) (envelope-from ) id 1bkJFj-00032T-EB; Wed, 14 Sep 2016 20:06:03 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , Jonathan Corbet , Jean Delvare , Guenter Roeck , Harry Wei , Mauro Carvalho Chehab , linux-hwmon@vger.kernel.org, linux-kernel@zh-kernel.org, Markus Heiser , Jani Nikula , LKML Subject: [PATCH 07/17] SubmitChecklist: rename to RST and add to the development-proccess book Date: Wed, 14 Sep 2016 20:05:52 -0300 Message-Id: <3955b817eeabc06c9088b4b59722c5e35c175e67.1473893776.git.mchehab@s-opensource.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: References: MIME-Version: 1.0 In-Reply-To: References: Sender: linux-hwmon-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-hwmon@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add it to the development-process book, by renaming it to SubmitChecklist.rst and move it to the development-process directory. Signed-off-by: Mauro Carvalho Chehab Reviewed-by: Jean Delvare --- .../{SubmitChecklist => development-process/SubmitChecklist.rst} | 2 +- Documentation/development-process/index.rst | 1 + Documentation/hwmon/submitting-patches | 2 +- Documentation/ja_JP/SubmitChecklist | 4 ++-- Documentation/ja_JP/SubmittingPatches | 2 +- Documentation/zh_CN/SubmittingPatches | 2 +- 6 files changed, 7 insertions(+), 6 deletions(-) rename Documentation/{SubmitChecklist => development-process/SubmitChecklist.rst} (98%) diff --git a/Documentation/SubmitChecklist b/Documentation/development-process/SubmitChecklist.rst similarity index 98% rename from Documentation/SubmitChecklist rename to Documentation/development-process/SubmitChecklist.rst index cf8559d6166f..71ad93ffd9d6 100644 --- a/Documentation/SubmitChecklist +++ b/Documentation/development-process/SubmitChecklist.rst @@ -54,7 +54,7 @@ and elsewhere regarding submitting Linux kernel patches. but any one function that uses more than 512 bytes on the stack is a candidate for change. -11: Include :ref:`kernel-doc ` to document global kernel APIs. +11) Include :ref:`kernel-doc ` to document global kernel APIs. (Not required for static functions, but OK there also.) Use ``make htmldocs`` or ``make pdfdocs`` to check the :ref:`kernel-doc ` and fix any issues. diff --git a/Documentation/development-process/index.rst b/Documentation/development-process/index.rst index 2c314a34c5f4..243041af82c3 100644 --- a/Documentation/development-process/index.rst +++ b/Documentation/development-process/index.rst @@ -18,5 +18,6 @@ Contents: stable_kernel_rules kernel-docs applying-patches + SubmitChecklist development-process diff --git a/Documentation/hwmon/submitting-patches b/Documentation/hwmon/submitting-patches index 371baf7a43e2..04b1036f07c4 100644 --- a/Documentation/hwmon/submitting-patches +++ b/Documentation/hwmon/submitting-patches @@ -10,7 +10,7 @@ increase the chances of your change being accepted. ---------- * It should be unnecessary to mention, but please read and follow - Documentation/SubmitChecklist + Documentation/development-process/SubmitChecklist.rst Documentation/development-process/SubmittingDrivers.rst Documentation/development-process/SubmittingPatches.rst Documentation/development-process/CodingStyle.rst diff --git a/Documentation/ja_JP/SubmitChecklist b/Documentation/ja_JP/SubmitChecklist index c0020797d6b9..a8e88eebc346 100644 --- a/Documentation/ja_JP/SubmitChecklist +++ b/Documentation/ja_JP/SubmitChecklist @@ -1,5 +1,5 @@ NOTE: -This is a version of Documentation/SubmitChecklist into Japanese. +This is a version of Documentation/development-process/SubmitChecklist.rst into Japanese. This document is maintained by Takenori Nagano and the JF Project team . If you find any difference between this document and the original file @@ -14,7 +14,7 @@ to update the original English file first. Last Updated: 2008/07/14 ================================== これは、 -linux-2.6.26/Documentation/SubmitChecklist の和訳です。 +linux-2.6.26/Documentation/development-process/SubmitChecklist.rst の和訳です。 翻訳団体： JF プロジェクト < http://www.linux.or.jp/JF/ > 翻訳日： 2008/07/14 diff --git a/Documentation/ja_JP/SubmittingPatches b/Documentation/ja_JP/SubmittingPatches index aed86762a6d3..22dcc16b3b08 100644 --- a/Documentation/ja_JP/SubmittingPatches +++ b/Documentation/ja_JP/SubmittingPatches @@ -34,7 +34,7 @@ Linux カーネルに変更を加えたいと思っている個人又は会社 おじけづかせることもあります。この文章はあなたの変更を大いに受け入れ てもらえやすくする提案を集めたものです。 -コードを投稿する前に、Documentation/SubmitChecklist の項目リストに目 +コードを投稿する前に、Documentation/development-process/SubmitChecklist.rst の項目リストに目 を通してチェックしてください。もしあなたがドライバーを投稿しようとし ているなら、Documentation/development-process/SubmittingDrivers.rst にも目を通してください。 diff --git a/Documentation/zh_CN/SubmittingPatches b/Documentation/zh_CN/SubmittingPatches index 8b93acb3a75e..97bc8639cbfc 100644 --- a/Documentation/zh_CN/SubmittingPatches +++ b/Documentation/zh_CN/SubmittingPatches @@ -30,7 +30,7 @@ Documentation/development-process/SubmittingPatches.rst 的中文翻译 对于想要将改动提交到 Linux 内核的个人或者公司来说，如果不熟悉“规矩”， 提交的流程会让人畏惧。本文档收集了一系列建议，这些建议可以大大的提高你 的改动被接受的机会。 -阅读 Documentation/SubmitChecklist 来获得在提交代码前需要检查的项目的列 +阅读 Documentation/development-process/SubmitChecklist.rst 来获得在提交代码前需要检查的项目的列 表。如果你在提交一个驱动程序，那么同时阅读一下 Documentation/development-process/SubmittingDrivers.rst 。