diff mbox series

Fix README formatting

Message ID CAHqJ0wG2trmAwmBJiGMZc2Jd4EUY1J2j3L38-BO5fXN-SMrkuw@mail.gmail.com
State New
Headers show
Series Fix README formatting | expand

Commit Message

Krystian Kuźniarek Nov. 8, 2020, 2:34 p.m. UTC 
Hi,

Assuming README is a Markdown file, I think there is a typo that changes
the meaning of code section as the closing ` character was probably
mistaken with '.

Enclosed are two images for graphical comparison as seen by a decent
markdown editor.

Patch:

From 2e6e7fb575e269bfae415e274ffa115a934829eb Mon Sep 17 00:00:00 2001
From: Krystian Kuzniarek <krystian.kuzniarek@gmail.com>
Date: Sat, 31 Oct 2020 13:53:56 +0100
Subject: [PATCH] Fix README formatting

Assuming that README is written in Markdown, this commit fixes broken
code sections.
---
 README | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

 already been corrected.

Comments

Florian Weimer Nov. 9, 2020, 12:31 p.m. UTC | #1 
* Krystian Kuźniarek via Libc-alpha:

> Assuming README is a Markdown file, I think there is a typo that changes
> the meaning of code section as the closing ` character was probably
> mistaken with '.

These are Texinfo quotes (which are derived from TeX's), and they are
used in other places in glibc (and other GNU software).

Thanks,
Florian
diff mbox series

Patch

diff --git a/README b/README
index d0f0edb393..3b4ef1aa7a 100644
--- a/README
+++ b/README
@@ -54,10 +54,10 @@  the GNU C Library.  You might also consider reading the
WWW pages for
 the C library at https://www.gnu.org/software/libc/.

 The GNU C Library is (almost) completely documented by the Texinfo manual
-found in the `manual/' subdirectory.  The manual is still being updated
+found in the `manual/` subdirectory.  The manual is still being updated
 and contains some known errors and omissions; we regret that we do not
 have the resources to work on the manual as much as we would like.  For
-corrections to the manual, please file a bug in the `manual' component,
+corrections to the manual, please file a bug in the `manual` component,
 following the bug-reporting instructions below.  Please be sure to check
 the manual in the current development sources to see if your problem has