From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 783CD727 for ; Mon, 21 Nov 2016 19:48:29 +0000 (UTC) Received: from osg.samsung.com (ec2-52-27-115-49.us-west-2.compute.amazonaws.com [52.27.115.49]) by smtp1.linuxfoundation.org (Postfix) with ESMTP id D93461D3 for ; Mon, 21 Nov 2016 19:48:28 +0000 (UTC) Date: Mon, 21 Nov 2016 17:48:20 -0200 From: Mauro Carvalho Chehab To: Johannes Berg Message-ID: <20161121174820.469b70f1@vento.lan> In-Reply-To: <1479743068.4391.4.camel@sipsolutions.net> References: <20161107075524.49d83697@vento.lan> <11020459.EheIgy38UF@wuerfel> <20161116182633.74559ffd@vento.lan> <2923918.nyphv1Ma7d@wuerfel> <20161119101543.12b89563@lwn.net> <1479724781.8662.18.camel@sipsolutions.net> <20161121120657.31eaeca4@vento.lan> <1479742905.2309.16.camel@HansenPartnership.com> <1479743068.4391.4.camel@sipsolutions.net> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Cc: ksummit-discuss@lists.linuxfoundation.org, "open list:DOCUMENTATION" , Linux Kernel Mailing List , James Bottomley , Linus Torvalds , Linux Media Mailing List Subject: Re: [Ksummit-discuss] Including images on Sphinx documents List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Em Mon, 21 Nov 2016 16:44:28 +0100 Johannes Berg escreveu: > > > > You had pointed me to this plugin before > > > > https://pythonhosted.org/sphinxcontrib-aafig/ > > > >=20 > > > > but I don't think it can actually represent any of the pictures. =20 > > >=20 > > > No, but there are some ascii art images inside some txt/rst files > > > and inside some kernel-doc comments. We could either use the above > > > extension for them or to convert into some image. The ascii art > > > images I saw seem to be diagrams, so Graphviz would allow replacing > > > most of them, if not all. =20 > >=20 > > Please don't replace ASCII art that effectively conveys conceptual > > diagrams.=C2=A0=C2=A0If you do, we'll wind up in situations where someo= ne > > hasn't built the docs and doesn't possess the tools to see a diagram > > that was previously shown by every text editor (or can't be bothered > > to dig out the now separate file).=C2=A0=C2=A0In the name of creating > > "prettier" diagrams (and final doc), we'll have damaged capacity to > > understand stuff by just reading the source if this diagram is in > > kernel doc comments.=C2=A0=C2=A0I think this is a good application of "= if it > > ain't broke, don't fix it". =20 I agree with it as a general rule. Yet, there are cases where the diagram=20 is so complex that rewriting it with Graphviz would make sense, like the one on this document: Documentation/media/v4l-drivers/pxa_camera.rst Regards, Mauro >=20 > Right, I agree completely! >=20 > That's the selling point of aafig though, it translates to pretty > diagrams, but looks fine when viewed in a normal text editor (with > fixed-width font) >=20 > I had a hack elsewhere that would embed the fixed-width text if the > plugin isn't present, which seemed like a decent compromise, but nobody > is willing to let plugins be used in general to start with, it seems :) >=20 > johannes Thanks, Mauro