From: Paul Mackerras <paulus@samba.org>
To: linux-kernel@vger.kernel.org
Cc: davidm@snapgear.com
Subject: [RANT] Totally inadequate commenting in flat.h
Date: Wed, 6 Nov 2002 10:55:33 +1100 [thread overview]
Message-ID: <15816.23157.790358.720568@argo.ozlabs.ibm.com> (raw)
Looking over the recent changes in Linus' tree, I saw there was this
new file, include/linux/flat.h. Hmmm, uninformative name, what's this
file about? I look in the file and here is how it starts:
/* Copyright (C) 1998 Kenneth Albanowski <kjahds@kjahds.com>
* The Silver Hammer Group, Ltd.
* Copyright (C) 2002 David McCullough <davidm@snapgear.com>
*/
#ifndef _LINUX_FLAT_H
#define _LINUX_FLAT_H
#define FLAT_VERSION 0x00000004L
/*
* To make everything easier to port and manage cross platform
* development, all fields are in network byte order.
*/
struct flat_hdr {
char magic[4];
unsigned long rev; /* version (as above) */
etc.
*Completely* uninformative. How is anyone supposed to know what this
relates to? Is it something to do with a network device, or a
filesystem, or an executable format, or what?
[And no, don't reply to this telling me what it's about, add some
comments to the file instead.]
Paul.
next reply other threads:[~2002-11-05 23:49 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2002-11-05 23:55 Paul Mackerras [this message]
2002-11-06 0:59 ` David McCullough
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=15816.23157.790358.720568@argo.ozlabs.ibm.com \
--to=paulus@samba.org \
--cc=davidm@snapgear.com \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®