Re: [HACKERS] PATCH: Spinlock Documentation
Hello, Thank you again for your feedback. I have improved the patch with your suggestions. Please let me know what you think and if I can do anything else. Current CommitFest link for this patch is: https://commitfest.postgresql.org/5/208/ Respectfully, Artem Luzyanin On Sunday, April 5, 2015 5:59 PM, Artem Luzyanin lisyono...@yahoo.ca wrote: Hello, Thank you very much for your feedback! I will work on the changes as soon as I can. Respectfully, Artem Luzyanin On Sunday, April 5, 2015 5:45 PM, Tom Lane t...@sss.pgh.pa.us wrote: David Fetter da...@fetter.org writes: One issue with this patch is that it is not localized. If someone goes and changes the S_LOCK implementation for one of the platforms below, or adds a new platform, etc., without changing this comment too, this comment becomes confusingly obsolete. Indeed. Moreover, this header comment is supposed to be an overview and specification of the macros that need to be provided. I think it's an actively bad idea to clutter it with platform-by-platform details; that will create a can't see the forest for the trees problem. If we need more info here, I think a comment block before each section of the file would make more sense. But the patch as provided seems like it would just be redundant if it were refactored in that form. What would possibly be useful that's not there now is a paragraph or two describing the overall layout of the file (eg gcc then non gcc, or whatever can be said at more or less that level of detail). But please don't stick that into the middle of the specification part. regards, tom lane spinlock-docsV2.patch Description: Binary data -- Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org) To make changes to your subscription: http://www.postgresql.org/mailpref/pgsql-hackers
Re: [HACKERS] PATCH: Spinlock Documentation
Hello, Thank you very much for your feedback! I will work on the changes as soon as I can. Respectfully, Artem Luzyanin On Sunday, April 5, 2015 5:45 PM, Tom Lane t...@sss.pgh.pa.us wrote: David Fetter da...@fetter.org writes: One issue with this patch is that it is not localized. If someone goes and changes the S_LOCK implementation for one of the platforms below, or adds a new platform, etc., without changing this comment too, this comment becomes confusingly obsolete. Indeed. Moreover, this header comment is supposed to be an overview and specification of the macros that need to be provided. I think it's an actively bad idea to clutter it with platform-by-platform details; that will create a can't see the forest for the trees problem. If we need more info here, I think a comment block before each section of the file would make more sense. But the patch as provided seems like it would just be redundant if it were refactored in that form. What would possibly be useful that's not there now is a paragraph or two describing the overall layout of the file (eg gcc then non gcc, or whatever can be said at more or less that level of detail). But please don't stick that into the middle of the specification part. regards, tom lane
[HACKERS] PATCH: Spinlock Documentation
Hello, I am new to PostgreSQLcommunity, but I would like to become a contributer eventually. I have readthrough your Submitting Patch guide and decided to follow Start with submitting a patch that is small anduncontroversial to help them understand you, and to get you familiar with theoverall process suggestion. I am interested inplatform-specific spinlock implementation, so I looked at s_lock.h file for possibleimprovement. Since it took me some time to find possible areas of improvement,I would like to submit a small patch that would facilitate the process forfuture contributors (including myself). Since this is my first e-mail, pleaselet me know if I should have done something differently in order to submit apatch for the community. Project name: Spinlock Documentation Uniquely identifiable file name: s_lock.h What the patch does: The patch implements addition to documentation in thementioned above file. This addition outlines the current platform-specificimplementations for an easy road map to what else could be done. Whether the patch is for discussion or forapplication: This patch is for application. Which branch the patch is against: This patch is against master branch. Whether it compiles and tests successfully: The changes allow for successful compilation andtesting. Whether it contains any platform-specificitems and if so, has it been tested on other platforms: This patch doesn’t have any platform-specific items. Confirm that the patch includes regression tests to check the newfeature actually works as described. Since this is documentation improvement, regressiontests are not needed. Include documentation on how to use the newfeature, including examples: Since it’s documentation improvement, nodocumentation is needed for documentation. Describe the effect your patch has onperformance, if any: No effect on performance. Unless we are talking aboutdeveloper’s performance. Try to include a few lines about why youchose to do things particular ways: I have decided to include the mentioned documentationto outline the areas that need improvement. Any developer, looking forplatform-specific code improvement implementation can now easily find theneeded area. Thankyou for your time and help, ArtemLuzyanin spinlock-docs.patch Description: Binary data -- Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org) To make changes to your subscription: http://www.postgresql.org/mailpref/pgsql-hackers
