From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 13213 invoked by alias); 24 Dec 2011 03:48:18 -0000 Received: (qmail 13202 invoked by uid 22791); 24 Dec 2011 03:48:17 -0000 X-SWARE-Spam-Status: No, hits=-1.7 required=5.0 tests=AWL,BAYES_00 X-Spam-Check-By: sourceware.org Received: from relay1.mentorg.com (HELO relay1.mentorg.com) (192.94.38.131) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Sat, 24 Dec 2011 03:48:03 +0000 Received: from svr-orw-exc-10.mgc.mentorg.com ([147.34.98.58]) by relay1.mentorg.com with esmtp id 1ReIaY-0003z6-39 from Yao_Qi@mentor.com for gdb-patches@sourceware.org; Fri, 23 Dec 2011 19:48:02 -0800 Received: from SVR-ORW-FEM-05.mgc.mentorg.com ([147.34.97.43]) by SVR-ORW-EXC-10.mgc.mentorg.com with Microsoft SMTPSVC(6.0.3790.4675); Fri, 23 Dec 2011 19:47:13 -0800 Received: from [127.0.0.1] (147.34.91.1) by svr-orw-fem-05.mgc.mentorg.com (147.34.97.43) with Microsoft SMTP Server id 14.1.289.1; Fri, 23 Dec 2011 19:48:01 -0800 Message-ID: <4EF54B6D.907@codesourcery.com> Date: Sat, 24 Dec 2011 07:45:00 -0000 From: Yao Qi User-Agent: Mozilla/5.0 (X11; Linux i686; rv:8.0) Gecko/20111110 Thunderbird/8.0 MIME-Version: 1.0 To: Subject: Re: FYI: minsyms documentation References: <4EF38DAD.3040106@earthlink.net> <8362h8z60x.fsf@gnu.org> <4EF39E85.3050207@earthlink.net> In-Reply-To: <4EF39E85.3050207@earthlink.net> Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit X-IsSubscribed: yes 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 X-SW-Source: 2011-12/txt/msg00817.txt.bz2 On 12/23/2011 05:17 AM, Stan Shebs wrote: > If everybody is able to madly hack away at the code without ever > consulting the internals manual, then what purpose is it serving > exactly? Are newbies learning by reading the manual, or reading the newbies are learning by manual reading at the beginning, even they can get more accurate information from comments in code later. > code? If the latter, then gdbint.texinfo content might get more > attention if it was redistributed into 1-2 page blocks at the tops of > relevant source files. This sounds good to me, but IMO, we still need gdbint.texinfo to describe the overall view of components of gdb and their relationships, which can not be put in source files. In JDK, all the documentation to a class and its methods are written in source file, and only one small text file is for package description. In package description, the overview is given and relationship of these classes is described. Most of the doc in details are still in comment of source file. I don't think we can copy this approach here, but we can do something similar here. Put detailed doc in gdbint.texinfo to relevant source files, and only leave overview and high-level doc in it. In this way, we don't have to pay much effort to keep gdbint.texinfo synchronized with source, and gdbint.texinfo is still quite useful. -- Yao (齐尧)