Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 12 May 2012 05:33:34 +1000 (EST)
From:      Bruce Evans <brde@optusnet.com.au>
To:        Warner Losh <imp@FreeBSD.org>
Cc:        svn-src-head@FreeBSD.org, svn-src-all@FreeBSD.org, src-committers@FreeBSD.org
Subject:   Re: svn commit: r235277 - head/sys/arm/arm
Message-ID:  <20120512051849.N2914@besplex.bde.org>
In-Reply-To: <201205111740.q4BHeDS9093430@svn.freebsd.org>
References:  <201205111740.q4BHeDS9093430@svn.freebsd.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Fri, 11 May 2012, Warner Losh wrote:

> Log:
>  This comment has become unmoored from the code to which it applies.
>  Move it back.

This commit message is unmoored from its this too (except when both are
collected in the commit mail).

> Modified: head/sys/arm/arm/locore.S
> ==============================================================================
> --- head/sys/arm/arm/locore.S	Fri May 11 16:09:12 2012	(r235276)
> +++ head/sys/arm/arm/locore.S	Fri May 11 17:40:13 2012	(r235277)
> @@ -42,12 +42,6 @@ __FBSDID("$FreeBSD$");
> /* What size should this really be ? It is only used by initarm() */
> #define INIT_ARM_STACK_SIZE	2048
>
> -/*
> - * This is for kvm_mkdb, and should be the address of the beginning
> - * of the kernel text segment (not necessarily the same as kernbase).
> - */
> -
> -

Like the commit message, this this doesn't clearly refer to anything.

The 2 blank lines are either intentional unmooring with 1 style bugs,
or 2 style bugs.   (When a this refers to multiple this's, and those
this's are separated by blank lines, attaching the this to the this's
by juxtaposition (with no blank lines) doesn't work, and one fairly
obscure way of indicating this is to attach the comment to nothing
(by separating it with a blank line.)

> #define	CPWAIT_BRANCH							 \
> 	sub	pc, pc, #4
>
> @@ -56,6 +50,10 @@ __FBSDID("$FreeBSD$");
> 	mov	tmp, tmp		/* wait for it to complete */	;\
> 	CPWAIT_BRANCH			/* branch to next insn */
>
> +/*
> + * This is for kvm_mkdb, and should be the address of the beginning
> + * of the kernel text segment (not necessarily the same as kernbase).
> + */
> 	.text
> 	.align	0
> .globl kernbase
>

This this now has its this near to it, but would still be clearer if this
were described explicitly.  That this seems to be simply kernbase, or
possibly kernbase and physaddr.  But this or that comment makes no sense
when attached to kernbase, because it says that this or that this is
NOT necessarily the same as kernbase.

These this's have intentionally fairly bad grammar so that it is unclear
what those this's are ;-).

Bruce



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20120512051849.N2914>