All of lore.kernel.org
 help / color / mirror / Atom feed
From: elfring@users.sourceforge.net (SF Markus Elfring)
To: cocci@systeme.lip6.fr
Subject: [Cocci] documentation improvements
Date: Mon, 20 Apr 2015 15:21:25 +0200	[thread overview]
Message-ID: <5534FD55.70401@users.sourceforge.net> (raw)
In-Reply-To: <20150420091540.GA7998@pema>

> However, improving the user documentation is part of
> what I am supposdd to do on Coccinelle dugring this year.

That is an interesting development.


> In particular, if you could let me know which are
> the areas which, according to you, are not so well documented,
> that woudl be helpful.

I see that there are improvement possibilities like the following.
* A bit of spell checking

* How are the chances to pass program parameter descriptions
  to a dedicated Latex macro so that more consistent
  formatting of the option collection can be achieved?

* Better outline around functionality from the semantic
  patch language

* Would additional links be useful?

* Can a tool like "OCamlDoc" also help?

Regards,
Markus

  reply	other threads:[~2015-04-20 13:21 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-19 15:37 [Cocci] version 1.0.0 Julia Lawall
2015-04-19 17:01 ` Derek M Jones
2015-04-19 17:14   ` Julia Lawall
2015-04-20  8:10 ` Wolfram Sang
2015-04-20  8:19   ` Julia Lawall
2015-04-20  8:25 ` SF Markus Elfring
2015-04-20  9:15   ` Sébastien Hinderer
2015-04-20 13:21     ` SF Markus Elfring [this message]
2015-04-20 13:43     ` Derek M Jones
2015-04-23 18:56 ` SF Markus Elfring

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=5534FD55.70401@users.sourceforge.net \
    --to=elfring@users.sourceforge.net \
    --cc=cocci@systeme.lip6.fr \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.