From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <mark@klomp.org>
Received: from gnu.wildebeest.org (wildebeest.demon.nl [212.238.236.112])
 by sourceware.org (Postfix) with ESMTPS id 590673857400
 for <debugedit@sourceware.org>; Fri, 30 Apr 2021 12:37:55 +0000 (GMT)
DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 590673857400
Authentication-Results: sourceware.org;
 dmarc=none (p=none dis=none) header.from=klomp.org
Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=mark@klomp.org
Received: from tarox.wildebeest.org (tarox.wildebeest.org [172.31.17.39])
 (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by gnu.wildebeest.org (Postfix) with ESMTPSA id 38A4E302BBEE;
 Fri, 30 Apr 2021 14:37:54 +0200 (CEST)
Received: by tarox.wildebeest.org (Postfix, from userid 1000)
 id 22798413CB92; Fri, 30 Apr 2021 14:37:54 +0200 (CEST)
Message-ID: <1eb6736a4891f2d3858140738a18c5551efd50bd.camel@klomp.org>
Subject: Re: [PATCH] find-debuginfo.sh: Add --help, --version and man page.
From: Mark Wielaard <mark@klomp.org>
To: "Dmitry V. Levin" <ldv@altlinux.org>
Cc: debugedit@sourceware.org
Date: Fri, 30 Apr 2021 14:37:53 +0200
In-Reply-To: <20210430121907.GF5477@altlinux.org>
References: <20210429224604.9906-1-mark@klomp.org>
 <20210429230630.GC29311@altlinux.org>
 <93393113c5d29d9861ef6ee5105062cfb3447b23.camel@klomp.org>
 <20210430121907.GF5477@altlinux.org>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
X-Mailer: Evolution 3.28.5 (3.28.5-10.el7) 
Mime-Version: 1.0
X-Spam-Status: No, score=-11.2 required=5.0 tests=BAYES_00, GIT_PATCH_0,
 KAM_DMARC_STATUS, SPF_HELO_NONE, SPF_PASS,
 TXREP autolearn=ham autolearn_force=no version=3.4.2
X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on
 server2.sourceware.org
X-BeenThere: debugedit@sourceware.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: debugedit development mailing list <debugedit.sourceware.org>
List-Unsubscribe: <https://sourceware.org/mailman/options/debugedit>,
 <mailto:debugedit-request@sourceware.org?subject=unsubscribe>
List-Archive: <https://sourceware.org/pipermail/debugedit/>
List-Post: <mailto:debugedit@sourceware.org>
List-Help: <mailto:debugedit-request@sourceware.org?subject=help>
List-Subscribe: <https://sourceware.org/mailman/listinfo/debugedit>,
 <mailto:debugedit-request@sourceware.org?subject=subscribe>
X-List-Received-Date: Fri, 30 Apr 2021 12:37:56 -0000

Hi Dmitry,

On Fri, 2021-04-30 at 15:19 +0300, Dmitry V. Levin wrote:
> It would look even nicer if EOF was quoted, e.g. 'EOF'.
> From bash manual page:
> "If any part of word is quoted, the delimiter is the result of quote
> removal on word, and the lines in the here-document are not
> expanded."
>=20
> [...]
> > +--unique-debug-src-base \"%{name}-%{VERSION}-
> > %{RELEASE}.%{_arch}\")
>=20
> I suggest to quote EOF once and forget about quoting anything in the
> whole text.

You are right again, the current escaping looks ugly in the --help
text. I fixed it like you suggested:

diff --git a/scripts/find-debuginfo.sh b/scripts/find-debuginfo.sh
index 5ea57ca..4f7ebef 100755
--- a/scripts/find-debuginfo.sh
+++ b/scripts/find-debuginfo.sh
@@ -19,7 +19,7 @@
=20
 help()
 {
-  cat <<EOF
+  cat <<'EOF'
 Usage: find-debuginfo.sh [OPTION]... [builddir]
 automagically generates debug info and file lists
=20
@@ -80,17 +80,17 @@ If --build-id-seed SEED is given then debugedit is
called to
 update the build-ids it finds adding the SEED as seed to recalculate
 the build-id hash.  This makes sure the build-ids in the ELF files
 are unique between versions and releases of the same package.
-(Use --build-id-seed \"%{VERSION}-%{RELEASE}\".)
+(Use --build-id-seed "%{VERSION}-%{RELEASE}".)
=20
 If --unique-debug-suffix SUFFIX is given then the debug files created
 for <FILE> will be named <FILE>-<SUFFIX>.debug.  This makes sure
.debug
 are unique between package version, release and architecture.
-(Use --unique-debug-suffix \"-%{VERSION}-%{RELEASE}.%{_arch}\".)
+(Use --unique-debug-suffix "-%{VERSION}-%{RELEASE}.%{_arch}".)
=20
 If --unique-debug-src-base BASE is given then the source directory
 will be called /usr/debug/src/<BASE>.  This makes sure the debug
source
 dirs are unique between package version, release and achitecture (Use
---unique-debug-src-base \"%{name}-%{VERSION}-%{RELEASE}.%{_arch}\")
+--unique-debug-src-base "%{name}-%{VERSION}-%{RELEASE}.%{_arch}")
=20
 All file names in switches are relative to builddir ('.' if not
given).
 EOF