This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] GTY documentation update


2010/11/9 Ralf Wildenhues <Ralf.Wildenhues@gmx.de>:
>> I am not sure how to achieve this with Gmail. .diff or .txt attachment
>> file extension perhaps? Does anyone have Gmail-specific tips here?
>
> I could offer http://www.google.com/search?q=sending+patches+with+gmail

Sorry, obviously I need a vacation.

For the record what I was able to find was either "don't use gmail web
interface to send patches" or "use git" but also I got an idea that an
IMAP MUA should work just fine, so trying now with one.

>> >> +If @code{field_vec->elts} stores @code{n} elements, then @code{size}
>> >
>> > I'd use @var{n} ...
>>
>> Texinfo manual says "Use the @var command to indicate metasyntactic
>> variables" and "Do not use @var for the names of particular variables
>> in programming languages." I have trouble understanding if n and size
>> are metasyntactic or not, so I really don't know which one to choose.
>
> There is an easy test to find out whether metasyntactic is right or not:
> If you replace all instances of the variable in question with X (or all
> instances of all variables in question with X1, X2, ...) and that does
> not change the meaning of the text, then a metasyntactic variable is
> appropriate.  In other words, the name of the variable has no relevance
> outside of the context of the manual.

Thanks, @var then it is.

>> Further comments,
>
> Not from me, you need somebody else to approve the patch if you cannot
> do it yourself.  I'm not sure if you can, you being GTY maintainer.

I am only a GTY reviewer, not maintainer.

Here is a v3, with @var and hopefully the attachment isn't encoded as
octet-stream.

Folks, comments or OK for trunk?

2010-11-09  Laurynas Biveinis  <laurynas.biveinis@gmail.com>

	PR/46268
	* doc/gty.texi (GTY Options): Clarify that variable_size produces
	allocators taking size in bytes, compare with length option.  Add
	size calculation example.
	(Invoking the garbage collector): Ensure that sentences are
	followed by two spaces.  Describe that pointer fields must be
	initialized at ggc_collect call.
	(Troubleshooting): New section.

-- 
Laurynas

Attachment: gty.texi.patch
Description: Text document


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]