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 A2555376 for ; Sun, 2 Jul 2023 01:46:06 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 98F6BC433C8; Sun, 2 Jul 2023 01:46:05 +0000 (UTC) Date: Sat, 1 Jul 2023 21:46:03 -0400 From: Steven Rostedt To: Jonathan Corbet Cc: Jani Nikula , ksummit@lists.linux.dev Subject: Re: Intersphinx ([TECH TOPIC] Kernel documentation) Message-ID: <20230701214603.6d0b299b@rorschach.local.home> In-Reply-To: <87y1k2kl5a.fsf@meer.lwn.net> References: <87fs6rxppz.fsf@meer.lwn.net> <871qi6glzl.fsf@intel.com> <87y1k2kl5a.fsf@meer.lwn.net> X-Mailer: Claws Mail 3.17.8 (GTK+ 2.24.33; x86_64-pc-linux-gnu) Precedence: bulk X-Mailing-List: ksummit@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit On Thu, 29 Jun 2023 15:34:41 -0600 Jonathan Corbet wrote: > There is a catch, though: In order to be able to create the cross > references, intersphinx has to be able to read the "objects.inv" file > for every other document it refers to. That file, of course, is created > by building the docs. In practice this means that, to generate a > complete set of manuals from a clean repository, it would be necessary > to do *two* complete builds - one to create the inventory files, and one > to use them. Could it be possible to check in these files into git, and have the Documentation maintainer update them whenever there's a need? (yes I like to volunteer people for jobs I don't do) This is similar to using flex and bison, where I have the files they generate prebuilt and checked in so that the user doesn't need to do it when they build the repository. -- Steve