From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-5.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 8D2ED7D910 for ; Tue, 11 Jun 2019 08:37:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2391365AbfFKIhh (ORCPT ); Tue, 11 Jun 2019 04:37:37 -0400 Received: from mail-ed1-f65.google.com ([209.85.208.65]:41249 "EHLO mail-ed1-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2391359AbfFKIhg (ORCPT ); Tue, 11 Jun 2019 04:37:36 -0400 Received: by mail-ed1-f65.google.com with SMTP id p15so18775381eds.8 for ; Tue, 11 Jun 2019 01:37:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ffwll.ch; s=google; h=sender:date:from:to:cc:subject:message-id:mail-followup-to :references:mime-version:content-disposition:in-reply-to:user-agent; bh=TbZbC+Sp2SPAwZltpEl7T+4dxXkbBpcXlsNbpfrSndo=; b=FaR8YuUFdDSfIP8hmPLLVMQ6SPKxLejrbqP75LhgLkqsJQOK4tyqQ4OY8OHSmc2+cB qk7BbUbMljJQAhtPYJlgu8QH+ZCqtwPvKyEGtNhlWgCsdAEL2j0M3nlmPgsiknjOvajc HorK2f0x9ImvVUoOoyFCMD1ZLZA0vQYfD4fSI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:date:from:to:cc:subject:message-id :mail-followup-to:references:mime-version:content-disposition :in-reply-to:user-agent; bh=TbZbC+Sp2SPAwZltpEl7T+4dxXkbBpcXlsNbpfrSndo=; b=CTCNlXnxMRvDmAGQO/0zRaqUqWjEtHnatZh+g/KImwAXAN0/MHG/aEVZkN5hoi2vaL 42UKtHnaXmas/+mp1XqTOPyNbgD42RF1VjMmHPJC1cJB0QgeLEQSCcBN3MeDX3wfOL1g rnlTfzxbk4ZMK8aT7WUrZIOm+DhwMIqKqbPj+csGXcLF7e8aLKVSVX6HEkzK/z8oP2s3 AojzIT8FQIRM48VSK/8l0bwTneisMVfHxo4X2A17MIT2XLTIjSYEgk2f0CMUX8fNuJFd JQ3EMqLGrVwcu0V5J4VV0rEwac56LoSSfwQcR50I9QPVIw9zsSbuM2sNs10LSvwJ4ruL JM2g== X-Gm-Message-State: APjAAAUtXdvAn+wRcdwUXCMY/KRJrbIV1Da9mf3RZco3cYNyO33FopZ2 PumFNjgJcXH6q5UIgDi7nTrrbw== X-Google-Smtp-Source: APXvYqwoHe+yWqlwWu+bfE6C9rrYPikgvhQ9xXtuj59UwLinYDko2BQBXR4dv1ZhUliGJnvW+jDHcg== X-Received: by 2002:a17:906:45d7:: with SMTP id z23mr12879082ejq.54.1560242254472; Tue, 11 Jun 2019 01:37:34 -0700 (PDT) Received: from phenom.ffwll.local ([2a02:168:569e:0:3106:d637:d723:e855]) by smtp.gmail.com with ESMTPSA id i21sm2162159ejd.76.2019.06.11.01.37.33 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Tue, 11 Jun 2019 01:37:33 -0700 (PDT) Date: Tue, 11 Jun 2019 10:37:31 +0200 From: Daniel Vetter To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Maarten Lankhorst , Maxime Ripard , Sean Paul , David Airlie , Daniel Vetter , dri-devel@lists.freedesktop.org Subject: Re: [PATCH v3 33/33] docs: EDID/HOWTO.txt: convert it and rename to howto.rst Message-ID: <20190611083731.GS21222@phenom.ffwll.local> Mail-Followup-To: Mauro Carvalho Chehab , Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Maarten Lankhorst , Maxime Ripard , Sean Paul , David Airlie , dri-devel@lists.freedesktop.org References: <74bec0b5b7c32c8d84adbaf9ff208803475198e5.1560045490.git.mchehab+samsung@kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <74bec0b5b7c32c8d84adbaf9ff208803475198e5.1560045490.git.mchehab+samsung@kernel.org> X-Operating-System: Linux phenom 4.14.0-3-amd64 User-Agent: Mutt/1.10.1 (2018-07-13) Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Sat, Jun 08, 2019 at 11:27:23PM -0300, Mauro Carvalho Chehab wrote: > Sphinx need to know when a paragraph ends. So, do some adjustments > at the file for it to be properly parsed. > > At its new index.rst, let's add a :orphan: while this is not linked to > the main index.rst file, in order to avoid build warnings. > > that's said, I believe that this file should be moved to the > GPU/DRM documentation. Yes, but there's a bit a twist: This is definitely end-user documentation, so maybe should be in admin-guide? Atm all we have in Documentation/gpu/ is internals for drivers + some beginnings of uapi documentation for userspace developers. Jon, what's your recommendation here for subsystem specific end-user/adming docs? Thanks, Daniel > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/EDID/{HOWTO.txt => howto.rst} | 31 ++++++++++++------- > .../admin-guide/kernel-parameters.txt | 2 +- > drivers/gpu/drm/Kconfig | 2 +- > 3 files changed, 22 insertions(+), 13 deletions(-) > rename Documentation/EDID/{HOWTO.txt => howto.rst} (83%) > > diff --git a/Documentation/EDID/HOWTO.txt b/Documentation/EDID/howto.rst > similarity index 83% > rename from Documentation/EDID/HOWTO.txt > rename to Documentation/EDID/howto.rst > index 539871c3b785..725fd49a88ca 100644 > --- a/Documentation/EDID/HOWTO.txt > +++ b/Documentation/EDID/howto.rst > @@ -1,3 +1,9 @@ > +:orphan: > + > +==== > +EDID > +==== > + > In the good old days when graphics parameters were configured explicitly > in a file called xorg.conf, even broken hardware could be managed. > > @@ -34,16 +40,19 @@ Makefile. Please note that the EDID data structure expects the timing > values in a different way as compared to the standard X11 format. > > X11: > -HTimings: hdisp hsyncstart hsyncend htotal > -VTimings: vdisp vsyncstart vsyncend vtotal > + HTimings: > + hdisp hsyncstart hsyncend htotal > + VTimings: > + vdisp vsyncstart vsyncend vtotal > > -EDID: > -#define XPIX hdisp > -#define XBLANK htotal-hdisp > -#define XOFFSET hsyncstart-hdisp > -#define XPULSE hsyncend-hsyncstart > +EDID:: > > -#define YPIX vdisp > -#define YBLANK vtotal-vdisp > -#define YOFFSET vsyncstart-vdisp > -#define YPULSE vsyncend-vsyncstart > + #define XPIX hdisp > + #define XBLANK htotal-hdisp > + #define XOFFSET hsyncstart-hdisp > + #define XPULSE hsyncend-hsyncstart > + > + #define YPIX vdisp > + #define YBLANK vtotal-vdisp > + #define YOFFSET vsyncstart-vdisp > + #define YPULSE vsyncend-vsyncstart > diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt > index 3d072ca532bb..3faf37b8b001 100644 > --- a/Documentation/admin-guide/kernel-parameters.txt > +++ b/Documentation/admin-guide/kernel-parameters.txt > @@ -930,7 +930,7 @@ > edid/1680x1050.bin, or edid/1920x1080.bin is given > and no file with the same name exists. Details and > instructions how to build your own EDID data are > - available in Documentation/EDID/HOWTO.txt. An EDID > + available in Documentation/EDID/howto.rst. An EDID > data set will only be used for a particular connector, > if its name and a colon are prepended to the EDID > name. Each connector may use a unique EDID data > diff --git a/drivers/gpu/drm/Kconfig b/drivers/gpu/drm/Kconfig > index 6b34949416b1..c3a6dd284c91 100644 > --- a/drivers/gpu/drm/Kconfig > +++ b/drivers/gpu/drm/Kconfig > @@ -141,7 +141,7 @@ config DRM_LOAD_EDID_FIRMWARE > monitor are unable to provide appropriate EDID data. Since this > feature is provided as a workaround for broken hardware, the > default case is N. Details and instructions how to build your own > - EDID data are given in Documentation/EDID/HOWTO.txt. > + EDID data are given in Documentation/EDID/howto.rst. > > config DRM_DP_CEC > bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support" > -- > 2.21.0 > -- Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch