QEMU-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: "Marc-André Lureau" <marcandre.lureau@gmail.com>
Cc: "Daniel P. Berrangé" <berrange@redhat.com>, QEMU <qemu-devel@nongnu.org>
Subject: Re: [Qemu-devel] [PATCH 0/4] docs: add docs about use of automatic cleanup functions
Date: Wed, 28 Aug 2019 13:30:15 +0100
Message-ID: <87d0gp5v6w.fsf@linaro.org> (raw)
In-Reply-To: <CAJ+F1CJsYQDAMwD9pHifGzFT=vPanBeKrCDvYmzqO522MeLhgg@mail.gmail.com>


Marc-André Lureau <marcandre.lureau@gmail.com> writes:

> Hi
>
> On Fri, Aug 23, 2019 at 8:41 PM Daniel P. Berrangé <berrange@redhat.com> wrote:
>>
>> This is ostensibly about adding docs for the g_autofree/g_autoptr
>> macros. As part of doing that, however, the existing HACKING doc
>> is merged into the CODING_STYLE doc and the text is converted to
>> markdown with a table of contents.
>
> Why not rst, so it can integrate with the rest of qemu sphinx doc?
>
> (markdown is quite poor when it comes to documenting code or
> cross-referencing etc)

I was going to say markdown does have the advantage of being renderable
on the fly on code hosting sites but it appears it works on
gitlab/github so that is an argument for being consistent with the rest
of the docs.

Does anyone know what is left to get the publishing pipeline up and
running and the results linked to from www.qemu.org?

>
>
>
>>
>> Daniel P. Berrangé (4):
>>   docs: convert CODING_STYLE and HACKING to markdown syntax
>>   docs: merge HACKING.md contents into CODING_STYLE.md
>>   docs: document use of automatic cleanup functions in glib
>>   docs: add table of contents to CODING_STYLE.md
>>
>>  CODING_STYLE    | 216 -----------------
>>  CODING_STYLE.md | 613 ++++++++++++++++++++++++++++++++++++++++++++++++
>>  HACKING         | 257 --------------------
>>  README          |   2 +-
>>  4 files changed, 614 insertions(+), 474 deletions(-)
>>  delete mode 100644 CODING_STYLE
>>  create mode 100644 CODING_STYLE.md
>>  delete mode 100644 HACKING
>>
>> --
>> 2.21.0
>>
>>


--
Alex Bennée


  reply index

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-23 16:39 Daniel P. Berrangé
2019-08-23 16:39 ` [Qemu-devel] [PATCH 1/4] docs: convert CODING_STYLE and HACKING to markdown syntax Daniel P. Berrangé
2019-08-28 12:25   ` Alex Bennée
2019-08-28 13:08     ` Daniel P. Berrangé
2019-08-23 16:39 ` [Qemu-devel] [PATCH 2/4] docs: merge HACKING.md contents into CODING_STYLE.md Daniel P. Berrangé
2019-08-23 19:35   ` Eric Blake
2019-08-28 15:06     ` Alex Bennée
2019-08-28 15:10       ` Daniel P. Berrangé
2019-08-23 16:39 ` [Qemu-devel] [PATCH 3/4] docs: document use of automatic cleanup functions in glib Daniel P. Berrangé
2019-08-23 19:53   ` Eric Blake
2019-08-28  9:00   ` Stefan Hajnoczi
2019-08-28 15:14   ` Alex Bennée
2019-08-28 15:20     ` Daniel P. Berrangé
2019-08-28 16:04       ` Alex Bennée
2019-08-23 16:39 ` [Qemu-devel] [PATCH 4/4] docs: add table of contents to CODING_STYLE.md Daniel P. Berrangé
2019-08-23 21:48 ` [Qemu-devel] [PATCH 0/4] docs: add docs about use of automatic cleanup functions Marc-André Lureau
2019-08-28 12:30   ` Alex Bennée [this message]
2019-08-28 13:07     ` Daniel P. Berrangé

Reply instructions:

You may reply publically 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=87d0gp5v6w.fsf@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=berrange@redhat.com \
    --cc=marcandre.lureau@gmail.com \
    --cc=qemu-devel@nongnu.org \
    /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

QEMU-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/qemu-devel/0 qemu-devel/git/0.git
	git clone --mirror https://lore.kernel.org/qemu-devel/1 qemu-devel/git/1.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 qemu-devel qemu-devel/ https://lore.kernel.org/qemu-devel \
		qemu-devel@nongnu.org
	public-inbox-index qemu-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.nongnu.qemu-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git