From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 835D619CCF5; Fri, 4 Apr 2025 17:43:43 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743788623; cv=none; b=ZIjGgTCCVJJ4yO9uZwoboJKySKATo+ZHdYyilMUxjB0WNa8c6PdlhDrh1prlfIdo+np1fhZFiK509HFHeIpUGlYWbfN1b86nZUQtDpO3diVOkzN1rolVy3nYlmdalwpXaoDq1Ic6buPootePHPqt2i74xOQHTUmspCbIFzEN/h4= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1743788623; c=relaxed/simple; bh=WJeqcUtnD+JvPCp95BzhzODUCYYMvFFmmq3rDIUcqSs=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version:Content-Type; b=tcy7qLBtxFanZuQO/YCGtlDU6pFXFAlFAQaN7fi1jDecrzrYbjsVxDNdgyN7ElQJVXNW6GCm7Lkx+xphD+eNGe5S0Z0TpImreVVLbJcLTV7Nr7+C3OC4KT/cq3NBn6R639rFiJpwzFAXl/sp3qbXQmTp1VKVlVeYbY/PaA+cxls= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=J4KPLgyY; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="J4KPLgyY" Received: by smtp.kernel.org (Postfix) with ESMTPSA id C47B2C4CEDD; Fri, 4 Apr 2025 17:43:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1743788622; bh=WJeqcUtnD+JvPCp95BzhzODUCYYMvFFmmq3rDIUcqSs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=J4KPLgyY3xGfSNoxx05BGJCDtfOgYphVQM1ZoldOdeeso2SYhM1km51rPHKPwB/pQ GJ06NvvjBNhsMQzJIvUMvXMETtTXsO0LWkcjP7CtqBfxJSSCZoye7qjPeoiOx1kiDt ZWKMHiBmHZU27kWXOQI7fbYGkDq4pvMtkkRYR1VoVIR6ij5Gkg20gJVinnvxc+4Hln 0pLMb4KNxVCrO46a7TfFtjc086KPWG07DJC5spzimeJtmGzO94ULDmiHBAOlWDVvJp ZHbUkDK/UYEW9K0mv7yvUZ5RZIpRiMCeq9pji34ELH1v5T9ZN5jyVg1V4+LWXJ2tCM WVxxdgswoKZSw== From: SeongJae Park To: =?UTF-8?q?N=C3=ADcolas=20F=20=2E=20R=20=2E=20A=20=2E=20Prado?= Cc: SeongJae Park , Andrew Morton , Jonathan Corbet , Vinod Koul , Eric Biggers , "Theodore Y. Ts'o" , Jaegeuk Kim , Jonathan Cameron , Lars-Peter Clausen , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Simon Horman , Maxime Chevallier , James Bottomley , Jarkko Sakkinen , Mimi Zohar , Jaroslav Kysela , Takashi Iwai , Mauro Carvalho Chehab , Richard Weinberger , Anton Ivanov , Johannes Berg , kernel@collabora.com, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, dmaengine@vger.kernel.org, linux-fscrypt@vger.kernel.org, linux-iio@vger.kernel.org, netdev@vger.kernel.org, workflows@vger.kernel.org, linux-integrity@vger.kernel.org, keyrings@vger.kernel.org, linux-sound@vger.kernel.org, linux-media@vger.kernel.org, linux-um@lists.infradead.org Subject: Re: [PATCH] docs: Remove literal markup from Documentation/ paths Date: Fri, 4 Apr 2025 10:43:39 -0700 Message-Id: <20250404174339.59650-1-sj@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250404-doc-paths-unliteral-v1-1-74718785444e@collabora.com> References: Precedence: bulk X-Mailing-List: workflows@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit On Fri, 04 Apr 2025 11:37:28 -0400 Nícolas F. R. A. Prado wrote: > Given that the automarkup Sphinx plugin cross-references > "Documentation/*.rst" strings in the text to the corresponding > documents, surrounding those strings with the literal markup (``) not > only adds unnecessary markup in the source files, but actually prevents > the automatic cross-referencing to happen (as it doesn't happen in > literal blocks). > > Remove all the occurrences of the literal markup in > "Documentation/*.rst" paths, except when the actual source file is being > referred. Also change the surrounding text when needed so it reads well > both in the source and the web page (eg. 'see file Doc...' -> 'see > Doc...'). > > Signed-off-by: Nícolas F. R. A. Prado Acked-by: SeongJae Park Thanks, SJ [...]