From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE, SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 856DBC3A59F for ; Thu, 29 Aug 2019 15:45:25 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 54DCD2166E for ; Thu, 29 Aug 2019 15:45:25 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="WfRT457y" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 54DCD2166E Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=lwn.net Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-ID:Subject:To:From:Date:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=dF6kJqigcyv97GuBk22+bRKxX1+sKB5kaita1BUv8mU=; b=WfRT457y1uHTAK 93ziGCnLthORHlGTIMC7yrk/AZE7l5EGIzeMmMwrqHNI1vix/YRpMvDbBryYitJK4mvGgBgbvInsI hc3sTWKbQAVKIEslgRQZS3ePXMirkkf8FuNj5g/YjZhKqdSXJgZPCOUKfsECuCO0SoWNMK+CT4zy0 Qwwhb9MEYJzg0nfr400eApX+755Bfuyius6VOt7LF8Q1oCM2l9yj9XIC+Rxz1gD+hbBE4ELAd/6Os oDPRNTGVNpgSEfhujmRSt0QdLRmYvUp6klIVqMdEVP8J/dk7pbmZetITpBhBaMi86y7iieJopnzdP OniZm3k8X+quEMtbxEMw==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92 #3 (Red Hat Linux)) id 1i3Mbn-00006G-Fn; Thu, 29 Aug 2019 15:45:11 +0000 Received: from ms.lwn.net ([45.79.88.28]) by bombadil.infradead.org with esmtps (Exim 4.92 #3 (Red Hat Linux)) id 1i3Mbi-0007d0-B4 for linux-arm-kernel@lists.infradead.org; Thu, 29 Aug 2019 15:45:07 +0000 Received: from lwn.net (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 272F02CF; Thu, 29 Aug 2019 15:44:59 +0000 (UTC) Date: Thu, 29 Aug 2019 09:44:58 -0600 From: Jonathan Corbet To: Alexandre Torgue Subject: Re: [PATCH] Documentation: add link to stm32mp157 docs Message-ID: <20190829094458.590884ba@lwn.net> In-Reply-To: <5257eff7-418b-8e94-1ced-30718dd3f5dc@st.com> References: <1566908347-92201-1-git-send-email-gerald.baeza@st.com> <20190827074825.64a28e88@lwn.net> <5257eff7-418b-8e94-1ced-30718dd3f5dc@st.com> Organization: LWN.net MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190829_084506_398529_0879001A X-CRM114-Status: GOOD ( 12.39 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: "linux-doc@vger.kernel.org" , "linux-kernel@vger.kernel.org" , "mcoquelin.stm32@gmail.com" , Gerald BAEZA , "linux-stm32@st-md-mailman.stormreply.com" , "linux-arm-kernel@lists.infradead.org" Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Tue, 27 Aug 2019 17:23:30 +0200 Alexandre Torgue wrote: > >> +Datasheet and reference manual are publicly available on ST website: > >> +.. _STM32MP157: https://www.st.com/en/microcontrollers-microprocessors/stm32mp157.html > >> + > > > > Adding the URL is a fine idea. But you don't need the extra syntax to > > create a link if you're not going to actually make a link out of it. So > > I'd take the ".. _STM32MP157:" part out and life will be good. > > > > We also did it for older stm32 product. Idea was to not have the "full" > address but just a shortcut of the link when html file is read. It maybe > makes no sens ? (if yes we will have to update older stm32 overview :)) Did you actually run it through Sphinx to see what you get? If I understand the effect you're after, you want something like this: The datasheet and reference manual are publicly available on STM32MP157_. .. _STM32MP157: https://www.st.com/en/microcontrollers-microprocessors/stm32mp157.html IOW you have to actually *use* the label you are setting up. That's a fine way to do it, I guess, though I'm not really convinced it's better than just putting the URL in directly. Thanks, jon _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel