From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S965114AbcIPRNZ (ORCPT ); Fri, 16 Sep 2016 13:13:25 -0400 Received: from tex.lwn.net ([70.33.254.29]:51319 "EHLO vena.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S935146AbcIPRNQ (ORCPT ); Fri, 16 Sep 2016 13:13:16 -0400 Date: Fri, 16 Sep 2016 11:13:14 -0600 From: Jonathan Corbet To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , Markus Heiser , Jani Nikula , LKML Subject: Re: [PATCH v3 07/21] Documentation/CodingStyle: Convert to ReST markup Message-ID: <20160916111314.5baa4f97@lwn.net> In-Reply-To: References: Organization: LWN.net X-Mailer: Claws Mail 3.13.2 (GTK+ 2.24.30; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, 14 Sep 2016 08:06:36 -0300 Mauro Carvalho Chehab wrote: > - Fix all chapter identation; > - add c blocks where needed; Here is where I think we need a bit of a philosophical discussion... > - Chapter 1: Indentation > +Indentation > +----------- You're a fan of having sphinx do the numbering, and I have no problem understanding why. But this will defeat people who say "look in chapter 3 of Documentation/CodingStyle". We're removing a bit of information from the plain-text file and reserving it for the formatted version. If we're really going to do that, we should do it consciously, with the knowledge that there is a cost involved. We'll see this even more with SubmittingPatches, where it is quite common for people to cite the number of the section they think is being violated in any given situation. jon