patches and low-level development discussion
 help / color / mirror / code / Atom feed
From: Alyssa Ross <alyssa.ross@unikie.com>
To: devel@spectrum-os.org
Cc: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
Subject: [PATCH] Documentation: rename "UUID" to "UUID Reference"
Date: Wed, 16 Nov 2022 10:54:23 +0000	[thread overview]
Message-ID: <20221116105423.610445-1-alyssa.ross@unikie.com> (raw)

The purpose of this document is specifically to provide a reference
table so that developers working with Spectrum can easily look up a
given UUID to find out what it means.

I think "UUID Reference" makes it clearer what the reader will find in
this document, as I'd expect a document just called "UUID" to be
something that explained e.g. what a UUID is.  (I don't think we need
to explain that at all in the Spectrum documentation, as we link to
Wikipedia, which explains it well, and it's background knowledge that
most developers looking to work with Spectrum will likely already
have.)

Signed-off-by: Alyssa Ross <alyssa.ross@unikie.com>
Cc: Jenni Nikolaenko <evgeniia.nikolaenko@unikie.com>
---
 Documentation/appendices/uuid-reference.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/appendices/uuid-reference.adoc b/Documentation/appendices/uuid-reference.adoc
index 146c068..5099ec3 100644
--- a/Documentation/appendices/uuid-reference.adoc
+++ b/Documentation/appendices/uuid-reference.adoc
@@ -1,4 +1,4 @@
-= Appendix B. UUID
+= Appendix B. UUID Reference
 :page-parent: Appendices
 :toclevels: 1
 :page-nav_order: 2

base-commit: 395346bd3341fd0468bc4f8a9c427440c5d05438
-- 
2.35.1



             reply	other threads:[~2022-11-16 10:54 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-16 10:54 Alyssa Ross [this message]
2022-11-17 12:55 ` [PATCH] Documentation: rename "UUID" to "UUID Reference" Jenni Nikolaenko
2022-11-18 10:17 ` Alyssa Ross

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=20221116105423.610445-1-alyssa.ross@unikie.com \
    --to=alyssa.ross@unikie.com \
    --cc=devel@spectrum-os.org \
    --cc=evgeniia.nikolaenko@unikie.com \
    /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.
Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/crosvm
	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/nixpkgs
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock
	https://spectrum-os.org/git/www

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).