From: Johannes Berg <johannes@sipsolutions.net>
To: Markus Heiser <markus.heiser@darmarit.de>
Cc: Jani Nikula <jani.nikula@linux.intel.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-wireless@vger.kernel.org,
linux-doc <linux-doc@vger.kernel.org>
Subject: Re: sequence diagrams in rst documentation
Date: Fri, 21 Oct 2016 23:17:47 +0200 [thread overview]
Message-ID: <1477084667.4068.61.camel@sipsolutions.net> (raw)
In-Reply-To: <EFAA684D-941C-45F9-8D37-F28EF3B11F4F@darmarit.de>
> I general I think, we should not include Java into our toolchains
> even if it is optional. Thats, why I won't vote for
> http://plantuml.com/
Keep in mind though that such a vote may well end up being a vote not
just against plantuml, but also against having sequence diagrams to
start with - at least as far as I'm concerned - since we (rightfully!)
also don't want to start writing our own infrastructure (again). There
aren't many alternatives. Even seqdiag/blockdiag isn't nearly as fully
featured as plantuml.
> IMO a tool which generates SVG would be the best, I have to check
> if I find some or if some of the above could used in this way.
plantuml does create svg :->
Ultimately, I actually think it doesn't matter much whether we add java
or python or whatever to our toolchain.
As soon as we add external dependencies that have to be fulfilled
outside of the kernel git tree, and such fulfilment is easy (as it is
in "sudo apt-get install plantuml python3-sphinxcontrib.plantuml"), it
hardly matters what exactly is behind it.
So ultimately, the way I see it, we essentially have two choices:
1) we reject external dependencies entirely, shipping everything in
the tree that we need to build documentation
2) we accept external dependencies, hopefully finding ways to make
them optional
In case of 1), which we obviously don't have today since we don't ship
sphinx and everything, we're basically reduced to having very simple
python-only plugins. As far as I'm concerned this will mean that I'm
not adding such diagrams to the kernel documentation, life's too short
to rewrite something like plantuml, and I can't find anything that's
pure python (and fulfilling your - IMHO a bit exaggerated - standards).
In case of 2), as long as it's easy to install on a typical Linux
distro, I think it doesn't actually matter that it's java or whatever
else.
johannes
next prev parent reply other threads:[~2016-10-21 21:17 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-11 12:56 [PATCH] docs-rst: sphinxify 802.11 documentation Johannes Berg
2016-10-11 13:21 ` Jonathan Corbet
2016-10-11 13:30 ` Johannes Berg
2016-10-11 21:39 ` Jonathan Corbet
2016-10-11 22:08 ` Johannes Berg
2016-10-12 17:20 ` Jonathan Corbet
2016-10-11 13:44 ` Johannes Berg
2016-10-11 13:53 ` Johannes Berg
2016-10-18 11:43 ` sequence diagrams in rst documentation Johannes Berg
2016-10-18 13:51 ` Markus Heiser
2016-10-18 14:12 ` Johannes Berg
2016-10-18 14:52 ` Jani Nikula
2016-10-18 19:20 ` Johannes Berg
2016-10-19 15:02 ` Markus Heiser
2016-10-19 15:17 ` Jani Nikula
2016-10-18 23:52 ` Jonathan Corbet
2016-10-19 7:51 ` Johannes Berg
2016-10-21 12:31 ` Johannes Berg
2016-10-21 12:56 ` Jani Nikula
2016-10-21 13:04 ` Johannes Berg
2016-10-21 16:11 ` Markus Heiser
2016-10-21 21:17 ` Johannes Berg [this message]
2016-10-21 21:19 ` Johannes Berg
2016-10-22 16:37 ` Markus Heiser
2016-10-22 20:30 ` Johannes Berg
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1477084667.4068.61.camel@sipsolutions.net \
--to=johannes@sipsolutions.net \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-wireless@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).