Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752761AbbKPNwk (ORCPT ); Mon, 16 Nov 2015 08:52:40 -0500 Received: from SMTP.ANDREW.CMU.EDU ([128.2.157.38]:57375 "EHLO smtp.andrew.cmu.edu" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751600AbbKPNwh (ORCPT ); Mon, 16 Nov 2015 08:52:37 -0500 Date: Mon, 16 Nov 2015 08:51:52 -0500 From: "Gabriel L. Somlo" To: Paolo Bonzini Cc: Rob Herring , gregkh@linuxfoundation.org, pawel.moll@arm.com, mark.rutland@arm.com, ijc+devicetree@hellion.org.uk, galak@codeaurora.org, arnd@arndb.de, lersek@redhat.com, ralf@linux-mips.org, rmk+kernel@arm.linux.org.uk, eric@anholt.net, hanjun.guo@linaro.org, zajec5@gmail.com, sudeep.holla@arm.com, agross@codeaurora.org, linux-api@vger.kernel.org, linux-kernel@vger.kernel.org, devicetree@vger.kernel.org, peter.maydell@linaro.org, matt.fleming@intel.com, mst@redhat.com, jordan.l.justen@intel.com, kernelnewbies@kernelnewbies.org, qemu-devel@nongnu.org, leif.lindholm@linaro.org, luto@amacapital.net, ard.biesheuvel@linaro.org, kraxel@redhat.com, stefanha@gmail.com Subject: Re: [Qemu-devel] [PATCH v4 4/4] devicetree: update documentation for fw_cfg ARM bindings Message-ID: <20151116135152.GE23241@HEDWIG.INI.CMU.EDU> References: <1447470235-13643-1-git-send-email-somlo@cmu.edu> <1447470235-13643-5-git-send-email-somlo@cmu.edu> <20151115020754.GA21323@rob-hp-laptop> <564995FA.40308@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <564995FA.40308@redhat.com> X-Clacks-Overhead: GNU Terry Pratchett User-Agent: Mutt/1.5.24 (2015-08-30) X-PMX-Version: 6.0.3.2322014, Antispam-Engine: 2.7.2.2107409, Antispam-Data: 2015.11.16.134517 X-SMTP-Spam-Clean: 8% ( MULTIPLE_RCPTS 0.1, HTML_00_01 0.05, HTML_00_10 0.05, BODYTEXTP_SIZE_3000_LESS 0, BODY_SIZE_1500_1599 0, BODY_SIZE_2000_LESS 0, BODY_SIZE_5000_LESS 0, BODY_SIZE_7000_LESS 0, DATE_TZ_NA 0, FROM_EDU_TLD 0, NO_CTA_URI_FOUND 0, NO_URI_FOUND 0, NO_URI_HTTPS 0, REFERENCES 0, __BOUNCE_CHALLENGE_SUBJ 0, __BOUNCE_NDR_SUBJ_EXEMPT 0, __CD 0, __CT 0, __CT_TEXT_PLAIN 0, __FORWARDED_MSG 0, __HAS_FROM 0, __HAS_MSGID 0, __IN_REP_TO 0, __MIME_TEXT_ONLY 0, __MIME_VERSION 0, __MULTIPLE_RCPTS_CC_X2 0, __PHISH_SPEAR_STRUCTURE_1 0, __REFERENCES 0, __SANE_MSGID 0, __SUBJ_ALPHA_END 0, __SUBJ_ALPHA_NEGATE 0, __TO_MALFORMED_2 0, __USER_AGENT 0) X-SMTP-Spam-Score: 8% Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1774 Lines: 40 On Mon, Nov 16, 2015 at 09:38:18AM +0100, Paolo Bonzini wrote: > On 15/11/2015 03:07, Rob Herring wrote: > > We generally don't want DT docs to depend on other kernel documentation. > > DT docs do not contain a copy of the data sheets, either. There is no > reason to say how to use the device (and even then, only doing so > partially) in the DT docs. I believe "Documentation/devicetree/bindings/arm/fw-cfg.txt" was added by Laszlo (via commit 53275a61) mainly to document the (base,size) DT node for ARM fw_cfg register set (based on the idea that Documentation/devicetree/... is the authoritative place to park DT node information like that. The additional bits about how fw_cfg works were added for context, since at the time the kernel itself didn't have anything else to do with fw_cfg. Since the sysfs driver I'm proposing (to allow fw_cfg data to be viewed from userspace) works on a wider set of architectures (x86, ARM, ppc/mac and sun4*), documentation on fw_cfg behavior belongs in a more cross-platform location, such as Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg. So Documentation/devicetree/bindings/arm/fw-cfg.txt should probably be limited to specifying the DT node details for ARM only. I figured it'd be nice to point at the new interface doc file to compensate for removing that information, but I'd be happy to not do that and just remove the redundant bits. Probably some of the stuff I just wrote should go into the commit log for the next version of the patch :) Thanks much, --Gabriel -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/