public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: "Michael Opdenacker" <michael.opdenacker@bootlin.com>
To: JPEWhacker@gmail.com, docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [RFC 0/1] initial documentation for hash equivalence
Date: Thu, 17 Jun 2021 21:55:29 +0200	[thread overview]
Message-ID: <20210617195530.258307-1-michael.opdenacker@bootlin.com> (raw)

Greetings

This is a first documentation attempt for hash equivalence.
I need to know if I'm headed in the right direction before expanding
the text if needed.

So, I would be interested in your opinion about:

- Is this the right level of detail?
  Don't forget that this is turned on by default in Poky
  and therefore easy to use.

  Would I need to add more details about the implementation,
  such as using explaining unihashes and adding diagrams such
  as the ones in Joshua Watt's presentation on the topic?

- It this the right place to add such documentation?

- Doesn't this need a more thorough update of the whole
  documentation about share state cache to give the new
  full picture right away, rather than adding this new
  feature later in the manual ?

- Anything else that I should mention?

- Anything wrong or that I misunderstood?

Michael Opdenacker (1):
  overview-manual: initial documentation for hash equivalence

 documentation/overview-manual/concepts.rst | 46 ++++++++++++++++++++++
 1 file changed, 46 insertions(+)

-- 
2.25.1


             reply	other threads:[~2021-06-17 19:55 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-17 19:55 Michael Opdenacker [this message]
2021-06-17 19:55 ` [RFC 1/1] overview-manual: initial documentation for hash equivalence Michael Opdenacker
2021-06-17 20:40   ` [docs] " Richard Purdie
2021-06-18 16:55     ` Michael Opdenacker
2021-06-17 20:47 ` [docs] [RFC 0/1] " Richard Purdie
2021-06-18 16:59   ` Michael Opdenacker

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=20210617195530.258307-1-michael.opdenacker@bootlin.com \
    --to=michael.opdenacker@bootlin.com \
    --cc=JPEWhacker@gmail.com \
    --cc=docs@lists.yoctoproject.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
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