From owner-freebsd-net@FreeBSD.ORG Wed Nov 16 11:26:06 2005 Return-Path: X-Original-To: freebsd-net@freebsd.org Delivered-To: freebsd-net@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id BCB3F16A41F for ; Wed, 16 Nov 2005 11:26:06 +0000 (GMT) (envelope-from gaylord@dirtcheapemail.com) Received: from lennier.cc.vt.edu (lennier.cc.vt.edu [198.82.162.213]) by mx1.FreeBSD.org (Postfix) with ESMTP id 5DC8E43D45 for ; Wed, 16 Nov 2005 11:26:05 +0000 (GMT) (envelope-from gaylord@dirtcheapemail.com) Received: from dagger.cc.vt.edu (IDENT:mirapoint@evil-dagger.cc.vt.edu [10.1.1.11]) by lennier.cc.vt.edu (8.12.11/8.12.11) with ESMTP id jAGBQ588008456; Wed, 16 Nov 2005 06:26:05 -0500 Received: from dirtcheapemail.com (e028121.vtacs.vt.edu [63.164.28.121]) by dagger.cc.vt.edu (MOS 3.6.4-CR) with ESMTP id EQX92428; Wed, 16 Nov 2005 06:26:04 -0500 (EST) Message-ID: <437B174B.1050405@dirtcheapemail.com> Date: Wed, 16 Nov 2005 06:26:03 -0500 From: Clark Gaylord User-Agent: Mozilla/5.0 (X11; U; FreeBSD i386; en-US; rv:1.5) Gecko/20040218 X-Accept-Language: en-us, en MIME-Version: 1.0 To: Jon , freebsd-net@freebsd.org References: <002e01c5ea94$35f05750$ba00a8c0@wtfzhangj> In-Reply-To: <002e01c5ea94$35f05750$ba00a8c0@wtfzhangj> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Cc: Subject: Re: hello, everyone , i have another question X-BeenThere: freebsd-net@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Networking and TCP/IP with FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 16 Nov 2005 11:26:06 -0000 Jon wrote: >I offten discover what such "/* XXX */ " annotate in source code of freebsd. what mean is "XXX"? > > These are "equivocation marks". They are placeholders for "I'm not sure I want to do this and want an easy way to find it again so I can undo it." Usually the intention is to come back and remove the equivocation marks once the code has passed some test (like: "it compiled! yea!") In many cases, they may be entirely vestigial, but in others the author may have felt that the solution still wasn't right, even though it worked, and wanted a visual clue to that effect for the reader. It is fair to say that the probability of bonehead code is somewhat higher in the vicinity of these marks. I usually initial and date my equivocation marks to help myself (and others) recognize vestiges, but this is an uncommon practice (unfortunately). In public repositories some people won't sign to protect themselves from embarrassment to the casual reader. --ckg