From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 50371 invoked by alias); 11 Jan 2018 22:27:52 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 49913 invoked by uid 89); 11 Jan 2018 22:27:50 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-25.6 required=5.0 tests=AWL,BAYES_00,GIT_PATCH_0,GIT_PATCH_1,GIT_PATCH_2,GIT_PATCH_3,SPF_PASS autolearn=ham version=3.3.2 spammy=picky X-HELO: sessmg23.ericsson.net Received: from sessmg23.ericsson.net (HELO sessmg23.ericsson.net) (193.180.251.45) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 11 Jan 2018 22:27:48 +0000 Received: from ESESSHC020.ericsson.se (Unknown_Domain [153.88.183.78]) by sessmg23.ericsson.net (Symantec Mail Security) with SMTP id 7B.CA.31026.1E4E75A5; Thu, 11 Jan 2018 23:27:45 +0100 (CET) Received: from EUR01-VE1-obe.outbound.protection.outlook.com (153.88.183.145) by oa.msg.ericsson.com (153.88.183.78) with Microsoft SMTP Server (TLS) id 14.3.352.0; Thu, 11 Jan 2018 23:27:45 +0100 Received: from [142.133.62.3] (192.75.88.130) by AM3PR07MB306.eurprd07.prod.outlook.com (2a01:111:e400:881b::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.407.1; Thu, 11 Jan 2018 22:27:42 +0000 Subject: Re: [PATCH] Install and generate docs for gdb-add-index To: Sergio Durigan Junior , GDB Patches CC: Tom Tromey , Eli Zaretskii References: <20180111213530.23774-1-sergiodj@redhat.com> From: Simon Marchi Message-ID: <43156279-dce3-2b0f-11d2-fc12061a2d55@ericsson.com> Date: Thu, 11 Jan 2018 22:27:00 -0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.5.0 MIME-Version: 1.0 In-Reply-To: <20180111213530.23774-1-sergiodj@redhat.com> Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit X-ClientProxiedBy: BN6PR1001CA0013.namprd10.prod.outlook.com (2603:10b6:405:28::26) To AM3PR07MB306.eurprd07.prod.outlook.com (2a01:111:e400:881b::14) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: bcd9c061-b99b-42f1-22b8-08d55942888a X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:(7020072)(4652020)(4534102)(4602075)(4627198)(201703031133081)(201702281549075)(5600026)(4604075)(2017052603307)(7153060)(7193020);SRVR:AM3PR07MB306; X-Microsoft-Exchange-Diagnostics: 1;AM3PR07MB306;3:02OVDjPdJpxiHjFV+g+gdCsYMgfhNCVglbUrr6tbO1lzIovYrVeGyKz+UNnY9ytCBOe5BvpH807cfCYL7cPQlTC+vUIB43lqhMaetq5ss/US81nPa17ywdIm+LukoK8q8c9vgjMmie5na9XRATZNs54CLfw0y6s8bxTNHKt6450gWWHk+7NEr0fEkl+R7qLWfO3DImuqfxjYHxTvQcDSmlSxQ0TKtF/lJOncvSaOSzA9i5oRdVKXWVRbRFQdy0Av;25:71HU2hCfR/zNrZQvjyJT39sI2GouzzpRjftEnlVJAhL6nReki9bGarNyACApClNFsS5e4Sz3wKhmJrtw+mFz6ZzdxxkfQ+IpaOvHiBgIdsE6IrWsO+bNy9DAgIBC4BaZC7Hbk7sF6qyUX/Eh9tZOPwvyzEQmJAgScwAqnrBmQMe8W9OXNmHlGe4DIXB4eXSebsKwgf02oKoofH3DjCAeYhfPq63chFc5bpiuf+y84VCRWEBbn2+bPRM2+8BCLttwT54Gq6bEXQWXuFaKA09TX2/11pSmMQxemVhzHT9YHOiqe7Z+5UmJTRrFO0+Mnhfl4tvnlYXy2ewgbnRT3c3EjxJnjWqAaAmpmz0ENtR71mA=;31:h7TOPT69UCGZ5QmAE4p+qid9cN9zvOSKufmERDFjN3Ck9vdkjhU8lX+UNXTgY4JGEnibByutyOkETJLz0GFSdPpu2EielHZryCiBJccUAO028zg6GH7Cq+zWSURx20JVJhw0Tses/nHtgiainG0GDWeBtPiTA6rpCXZ6lkcysTK5dq0o14vGp4Z6AxkYVMfqifuxDlkxdky6eiml94/lauLlZLzVlJuWqQs4Wt3tbes= X-MS-TrafficTypeDiagnostic: AM3PR07MB306: X-Microsoft-Exchange-Diagnostics: 1;AM3PR07MB306;20:Gali9+7TCtzEvDdl8UElHfHpStOYiZIHO1AjgiJEz272Iz5awux83tE91m6X+vCGoD6i5iJMUu20BfPk1ouM8fZzWBj41Isi7u3gWgecVkPWJGZzfZyz76FH3bFctDEeQ6WaR2GYuwCyIo3Z/bRCju+EIR5PgFNamqf8PwOr0qnqKf6POiec4gy6Kg9f5U8Vz04lgS/O7wJOQjmx0WYS9EqjYE+BCvqKuCOOyxvV+erFP3h8B8UAIqwmozKroNncv/ic863oOsyhXeYUVUW9xS7ZNc9HfPtwE2N8KUcS2Fe/KYTul1Jbk4NCICPrrOH/1f82zfTP4glUuVUVnwGkIm67DT6BhB7azvppMguLgYWuiDSE2aFLkVRpzqah+RpNAKq+7vPqMJZn/bDAzWTbXIErM9GqIVy9F+J0kTb9xK01u5cB9QTHs6/ftXVn7gf8YQhqZ3dB03W9Bgg6hVA6OH2Ba7q7GPCH0fdwgrQ2IZpYHDEEfYM30Q3mnMbVTUP2;4:xWKlTrFAKFSCEmotFsXQF+f65QHD0Fb4vSSoY8M2uLm+ykFJb6tmHFlBASnGyNMMS/Px0mCEMTfpss6uHqIsoIXUWTnj4WGibTaHBTRBS19hkat1ZWF/q0dv2IkCv7qqleV7ohLjirUaAwYHmbY49qyzvTSNkxo4LGJM0GnszQxeL392U1wYAsQR9b8pvkgcSBAIoruB6znQSaeo67+AMVUBMFRLsORNT09Sdj24aqEDdO7wCdCxKxLCTCxWdJhXpHNMQNJO2C2vRyXBuxqRvoc8qTg4Adw3IlksG4+HbVdGJdJBOeR0xoQwfCrbNqao X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(85827821059158); X-Exchange-Antispam-Report-CFA-Test: BCL:0;PCL:0;RULEID:(6040470)(2401047)(5005006)(8121501046)(3231023)(944501136)(3002001)(93006095)(93001095)(10201501046)(6041268)(20161123560045)(20161123564045)(20161123562045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123558120)(6072148)(201708071742011);SRVR:AM3PR07MB306;BCL:0;PCL:0;RULEID:(100000803101)(100110400095);SRVR:AM3PR07MB306; X-Forefront-PRVS: 0549E6FD50 X-Forefront-Antispam-Report: SFV:NSPM;SFS:(10009020)(979002)(6049001)(39380400002)(366004)(39860400002)(396003)(376002)(346002)(24454002)(199004)(189003)(377424004)(6116002)(2486003)(23676004)(76176011)(52116002)(53546011)(386003)(52146003)(53936002)(65956001)(65806001)(25786009)(66066001)(2906002)(6246003)(4326008)(305945005)(230783001)(31696002)(3846002)(36756003)(31686004)(6666003)(47776003)(2950100002)(65826007)(6486002)(229853002)(105586002)(106356001)(81156014)(86362001)(5660300001)(97736004)(7736002)(64126003)(8936002)(478600001)(50466002)(49976009)(8676002)(16526018)(83506002)(68736007)(81166006)(6346003)(230700001)(58126008)(16576012)(316002)(110136005)(54906003)(78286006)(969003)(989001)(999001)(1009001)(1019001);DIR:OUT;SFP:1101;SCL:1;SRVR:AM3PR07MB306;H:[142.133.62.3];FPR:;SPF:None;PTR:InfoNoRecords;A:1;MX:1;LANG:en; Received-SPF: None (protection.outlook.com: ericsson.com does not designate permitted sender hosts) Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=simon.marchi@ericsson.com; X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtBTTNQUjA3TUIzMDY7MjM6cHRja2EzanZ2b1Q4MnlkSTlERThqZ3B0ck8x?= =?utf-8?B?RE5rYzA1VGw0MnVucE1OTVVYd3d2a0tuYllkN29YU09rOXF4Q3NFN2krMzhH?= =?utf-8?B?eHZHdm1IYkgzYmhuTjBqTk5CdnRXNjJyVVdub3ZlYVVkNXVHbDA2M0lpNGZC?= =?utf-8?B?YnRLTlBEZ1FFMmNnQW1OdG1PRUE0VXdkZ0VDRTZwL2Z4REFaTTY0YVlkNk9B?= =?utf-8?B?Yms0NVBYak5uckMwWWxCczVBc3B6NHBNdGxsSmhmN0Fpc2RCTDA2Tm40S1ZZ?= =?utf-8?B?MVp1cG40VXNPZng1TDA0Rjg3enJ1SmtQd0dMQ3FCSTNjWXdDQmp5eWtOWjls?= =?utf-8?B?TWZFUXQxdm9Mck5PK0JLcDh4bjhPVFBzVGUxT0ZuUDBSMThpdm9iWUx4WnVE?= =?utf-8?B?VWEwM1lPT2pYd1VoN2NPakl2UVBXeDRkUVhBK2RYaFVINXB0TU4yU2wxU212?= =?utf-8?B?bjRQdGtKWlNndkhoa0duWkJYQ1hNWVZ2L0xoenFHMHUwS1R0TzRxVjJWczlE?= =?utf-8?B?YlY1VXNTd0NTTFp3azNXa2pJVFVZcXdHWVBQNE1YbCtpdWVkeEJNb0F3d3FF?= =?utf-8?B?NnYzRFBqMGExSjYyWUJFcHlLSENpcEloZG1Sam4wZHNhbXdYSjFtVWR3YkdP?= =?utf-8?B?cHR6SzlQTGlwR09FZmRCRk9vdjdHTGc5NzJqMkl0TEFiY3pTa0ZMMnRpN1RX?= =?utf-8?B?RDI3NVBrdVMyRW1LMndISG5NdUlFK1J5bnhYUG5YREQrN2hmOExXa3JUdWdL?= =?utf-8?B?QmppK3gxa3pRN0xUdkxXVXFIVzBmR3ZsV3pBMEYweVJaVGlkZVFUaDMyMFIr?= =?utf-8?B?c015TE9zcmtMWWpiU0YrbUw4Vjk2YVRGV3pxMTVmcnZzL25VaHBNQmRVN25o?= =?utf-8?B?L2ppSStrV0JMUitscjJNRXpYU2ZLUHlYWDY4Y1BPcHBMVkcvNHJpK0FsaVFE?= =?utf-8?B?WG9WelJ5OGdTQmNhZ2FubThydzNRKzkrdDM4TkFXSHloR3gxUEprcDM3YmN1?= =?utf-8?B?dXRLZURTd3RuaXkzWnh1UzBXUHJIUUZjZ1pEK0szdXJSQkt2WEdwOTF4L0pi?= =?utf-8?B?TWlkOVpBeWlrc1FDc3NxZUxVdXFndzgwVkZDR21MMndEVzBOMWZvMW96eVoz?= =?utf-8?B?ZEZvczRhS3d1ZE9mL3ZURXRjUHgwMWprTm0zbUc0alE5ai9qQ0pjQ3paY0NH?= =?utf-8?B?cmVDdFJuVTg2NWdXK2x6L0FOcUwxblViQ3NUZGhndXpUTGFoUnREWnNXUGZI?= =?utf-8?B?cG9kbmNrMnV6dDRaSzgzRERTYVNDdzVyT3VJV3RWbklXaCtvTDlETUNaY0Iz?= =?utf-8?B?aTJGQUVlVlNPR0ZQQVVtV1dncDA5c0liUVBhTmZIYkNObElTRGVpMlYvTWFO?= =?utf-8?B?bTE5RE9CbEEwS0YzZUg4WWJ5cytjYm51LzdrSllnUVg1dUhxQ2lSc3U0aWF0?= =?utf-8?B?Q1c3bHhGQVV6ejdyWEdVTGJLdktqL0sycW5NZXI4VlZ1RkNEWXI0YkI4VW5k?= =?utf-8?B?L2dSL3drU0VFRFhxS2JjMWdRY1RNU0VZOEd3blVGQlhuS2FIclAxRkRaLzBy?= =?utf-8?B?UGY3ZWNpZCtYSlMySDFvQmtDekJLeUFpaEZPeDN3K3l3NW5Ea0NoWGtRTmtU?= =?utf-8?B?NjI4Z3BjazFibzlER2N4ZEV2WE02VFh2Z0RSOEJkeGFtVkVhYXFNak92OWlw?= =?utf-8?B?VnE0RHNvQldyVWFGUWpPMjlXYXNXKzM0MmdYNzFnaEcxcE9yU3dXUllmQ2Nq?= =?utf-8?B?dFNsTWpWdm5HUjZuL0hocld2WDBCMmU3bHNhYWR5NDFJSWYxV0FBUXFJWEJS?= =?utf-8?B?R0ZLeUtCWTNkQm96M0xlMUJ4MVpGRTNqQXM4UW9jdTdzWDJWTnZabjN6Y3Rv?= =?utf-8?B?aXdVMUVoQStJWFN1WkRQTmIyaHYwQ1Nra1pWK2hOUnlOMmlHN1UyTGVjVFNQ?= =?utf-8?B?ZWNUVzlGWUlGVkVLNG1FcEFRbDVzWE1KWEVZUFB6N0JCMy90VlRYLzZPNExn?= =?utf-8?B?L3h6alpBQ25jRm5JS0ZQc3E0SmcxOTN3U2RKWWRJenBOeTFBK0EyRnQrMGdw?= =?utf-8?B?NGMxaWsrMG5NTm5YMVVHdUFNeHF1WlhoT2NXR2FUS011VVFVUmlpV3NZc2Jw?= =?utf-8?B?dz09?= X-Microsoft-Exchange-Diagnostics: 1;AM3PR07MB306;6:baYWYyrKdZi5W76deG/h2LxQJh1XrJ+LLe90rGYozMD7dKaUS+CGyGhupgIYMjsIJ3kMyfuLRnJwGcRvbsi+5PpSjsFh71QJbhgLB5V0PuoPkwyk/Dy601fsAQ3iMVqenBTaLanfxONFalFqq4MJI7++DSg5IHdNijjE0MZ+D9ADu4fWoXSQECj1C2HIYsxV/GbVhZ5871/HM2CAkgvA/UemDzt5mvCSk0DyyFohQydqFPBz8HvpmuV4V1QHlt+SV0CWV8T1nUZ2ItwFyi48Bc1oPFl2Y7dyZRwPIziUyQpF1bzkmRqei5c/qNWYJAjb3Su4GaUbT78R1Ymqdv2OJs3FZPQo/wev9IgeyLY3E7A=;5:DuOtlP9RQVplIUKV+6b7XXk55jHgSUdisM+TUqq3jvRUZ6DgmiuRURMBUtI8i6JIEASSs7Rz8svpYnQh48IW7aiSzW8OKHYiHgk+1PlE673OaILCEImWxvxXb+E1xyW3rR7PfAQJPqrlH+xYJcwrbsdM3jzjyD5Hx/uwksUo0yU=;24:d7kZJuJc+QK45PCZQgwwkOuL0Gxm0qU4BHFoPyp4CBr7u96PZAe+InYd7gm2ArfrMoCTwkYLmXhsp8mFWF4X5ixZcu4PtsnQuUhoBThttmE=;7:XUOkVQOgcw+OGAurWwMvUyUgRIeOsF2z7ZX2Z+OGBMozF3I+i8nWQnmDTxOM+kbjMxllExJ+nPaVwf8lJ6wI2oawuUM1axKGklCUz+BZdZY+YcmYfAA0rr7aKdu8MkfLy7s7FO1dig1/UfYRHCwBmTQUjRbEkU1SDLaVmbh4WGlw0+oNa+ojDMihLt88BwX1dLuXnjR1larNW9zRxXBCDY2GOZjZlgiDuPGv7Kqm6CaCHKOG+Iku45cOtkAbaLmM SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Jan 2018 22:27:42.7198 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: bcd9c061-b99b-42f1-22b8-08d55942888a X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 92e84ceb-fbfd-47ab-be52-080c6b87953f X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM3PR07MB306 X-OriginatorOrg: ericsson.com X-IsSubscribed: yes X-SW-Source: 2018-01/txt/msg00221.txt.bz2 On 2018-01-11 04:35 PM, Sergio Durigan Junior wrote: > The "gdb-add-index" script has been resurrected on: > > commit caf26be91a584ef141ac5d3cb31007731af8b8e3 > Author: Samuel Bronson > Date: Fri Nov 15 16:09:33 2013 -0500 > > Resurrect gdb-add-index as a contrib script > > However, for some reason (I couldn't find it in the archives), only > the script has been checked-in; the Makefile parts responsible for > installing it in the system were left out. This commit fixes that, by > also resurrecting the Makefile and documentation bits. > > This commit is part of our effort to upstream the local Fedora GDB > changes. With this commit, we'll only carry a very small > Fedora-specific modification to the script. Woo thanks! I have some comments, but I'm just being picky. > diff --git a/gdb/Makefile.in b/gdb/Makefile.in > index 17b71c6e7c..d63220db4e 100644 > --- a/gdb/Makefile.in > +++ b/gdb/Makefile.in > @@ -1770,6 +1770,15 @@ install-only: $(CONFIG_INSTALL) > $(INSTALL_SCRIPT) gcore \ > $(DESTDIR)$(bindir)/$$transformed_name; \ > fi > + transformed_name=`t='$(program_transform_name)'; \ > + echo gdb-add-index | sed -e "$$t"` ; \ > + if test "x$$transformed_name" = x; then \ > + transformed_name=gdb-add-index ; \ > + else \ > + true ; \ > + fi ; \ > + $(INSTALL_PROGRAM) $(srcdir)/contrib/gdb-add-index.sh \ > + $(DESTDIR)$(bindir)/$$transformed_name$(EXEEXT) I know this is just copy pasted from above, but doesn't the indentation look odd? Shouldn't the if/else/fi and the INSTALL_PROGRAM lines be indented with one tab less? > @$(MAKE) DO=install "DODIRS=$(SUBDIRS)" $(FLAGS_TO_PASS) subdir_do > > install-strip: > diff --git a/gdb/doc/Makefile.in b/gdb/doc/Makefile.in > index eafadee899..0323bc4ecb 100644 > --- a/gdb/doc/Makefile.in > +++ b/gdb/doc/Makefile.in > @@ -174,7 +174,7 @@ POD2MAN5 = pod2man --center="GNU Development Tools" \ > --release="gdb-`sed q version.subst`" --section=5 > > # List of man pages generated from gdb.texi > -MAN1S = gdb.1 gdbserver.1 gcore.1 > +MAN1S = gdb.1 gdbserver.1 gcore.1 gdb-add-index.1 > MAN5S = gdbinit.5 > MANS = $(MAN1S) $(MAN5S) > > @@ -633,6 +633,13 @@ gcore.1: $(GDB_DOC_FILES) > mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) > rm -f gcore.pod > > +gdb-add-index.1: $(GDB_DOC_FILES) > + touch $@ > + -$(TEXI2POD) $(MANCONF) -Dgdb-add-index < $(srcdir)/gdb.texinfo > gdb-add-index.pod > + -($(POD2MAN1) gdb-add-index.pod | sed -e '/^.if n .na/d' > $@.T$$$$ && \ > + mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1) > + rm -f gdb-add-index.pod > + > gdbinit.5: $(GDB_DOC_FILES) > touch $@ > -$(TEXI2POD) $(MANCONF) -Dgdbinit < $(srcdir)/gdb.texinfo > gdbinit.pod > diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo > index dba2fa766a..62fcdd524e 100644 > --- a/gdb/doc/gdb.texinfo > +++ b/gdb/doc/gdb.texinfo > @@ -19775,6 +19775,14 @@ There are currently some limitation on indices. They only work when > for DWARF debugging information, not stabs. And, they do not > currently work for programs using Ada. > > +@value{GDBN} comes with a program, @command{gdb-add-index}, which can > +be used to add the index to a symbol file. It takes the symbol file > +as its only argument: > + > +@smallexample > +$ gdb-add-index symfile > +@end smallexample > + Would it be good to put the part about gdb-add-index earlier in the page/section, for example just after the first paragraph? The doc starts by telling you the manual method with the scary objcopy lines and all. I think it would be nice if it started by telling: here's the easy and recommended way, and then here are all the gory details about how it's done internally, if you need it. I could imagine users starting to read the section, and stopping midway because they think it's too complicated/not worth it, and never get to the gdb-add-index part. Simon