Created attachment 85661 [details] Patch that adds the man-page for __ppc_get_timebase glibc 2.16 included a new function to read the Time Base Register on Power processors on the following commit: http://sourceware.org/git/?p=glibc.git;a=commit;h=d9dc34cd569bcfe714fe8c708e58c028106e8b2e The attached patch adds the new man-page and applies to the master branch.
Hello Tulio, What's the significance of the __" prefix in this function name? Is this function really intended for userspace? Also, what about __ppc_get_timebase_freq(). Does it likewise need to be documented?
(In reply to comment #1) > What's the significance of the __" prefix in this function name? It was a convention adopted for platform specific functions. You may find more information in http://www.gnu.org/software/libc/manual/html_node/Adding-Platform_002dspecific.html#Adding-Platform_002dspecific > Is this function really intended for userspace? Yes. > Also, what about __ppc_get_timebase_freq(). Does it likewise need to be > documented? Yes. I'm also planning to prepare it's manpage.
Would it make sense to document both functions on one page (since they seem closely related)?
Yes. I also think this test [1] is good candidate for an example on how to use them. [1] - http://sourceware.org/git/?p=glibc.git;a=blob;f=sysdeps/unix/sysv/linux/powerpc/test-gettimebasefreq.c;hb=HEAD
(In reply to Michael Kerrisk from comment #1) > Hello Tulio, > > What's the significance of the __" prefix in this function name? Is this > function really intended for userspace? > > Also, what about __ppc_get_timebase_freq(). Does it likewise need to be > documented? Hello Tulio, Okay -- this fell on the ground for a very long time. Sorry about that. But your patch is applied now. What shall we do about __ppc_get_timebase_freq()? (I see there is documentation in the glibc manual.) Thanks, Michael
(In reply to Michael Kerrisk from comment #5) > Okay -- this fell on the ground for a very long time. Sorry about that. But > your patch is applied now. Thanks for applying it! > What shall we do about __ppc_get_timebase_freq()? (I see there is > documentation in the glibc manual.) Yes, it does. I'll add it to the same man page. Just give me some time because I'll be on a trip for the next 2 weeks.
(In reply to Michael Kerrisk from comment #5) > What shall we do about __ppc_get_timebase_freq()? I've just sent a patch adding it to the same page. http://marc.info/?l=linux-man&m=143258058005074&w=2
Patch applied. Closing.