You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2020/05/20 00:36:05 UTC
[GitHub] [incubator-nuttx] patacongo opened a new pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
patacongo opened a new pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083
## Summary
Documentation/NuttXCCodingStandard.html:
- Fix a typo: "be aligned so that the comment begins in the same comment on each line." Of course that should have been column.
- Update a coding standard requirement. With regard to Comments to the Right of Statements, the document said: "If such comments are used, they should ... fit on one line." This is not true any more. In common practice (include the checks in nxstyle), comments to the right of statements may be continued to the following line. The standard way of continuing such comments was also documented.
Documents/style.css: It appears that a varible with font was being used for \<pre\> and \<code\>, that was really screwing up the presentation, especially in the coding standared where there are many examples illustrating correct vertical alignment. The font type "Bitstream Vera Sans Mono" was replaced with "courier" for \<pre\> and \<code\>
## Impact
None
## Testing
N/A
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083#issuecomment-631841946
I clicked to check to see if it was pointing at something else but I did not actually change any setting so I don't know :/ next time we update it I'll look more carefully.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083#issuecomment-631558168
@patacongo I'll take a look this evening, it should be basically instant.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083#issuecomment-631169585
You can find the Artifacts here https://github.com/apache/incubator-nuttx/actions/runs/109880466
On the Documentation [page](https://cwiki.apache.org/confluence/display/NUTTX/Documentation)
You can click the "..." can select [Attachments](https://cwiki.apache.org/confluence/pages/viewpageattachments.action?pageId=139629402) which takes you to the page where all the Documents are attached. You can the upload the missing file (bottom of the page).
You can see all the version of a file by clicking the '>' icon next to it
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo edited a comment on pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
patacongo edited a comment on pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083#issuecomment-631435102
@btashton In this case the style sheet has changed so really all documents should be updated. I won't do that for now.
It looks like no new documents have been uploaded since the original ones that you did on Dec 19. I just updated all of the documents that have changes since Dec. 19 and they do appear in the Attachments. However, the pages under Documents have not changed; they do not show the updated versions. So I must be doing something wrong. It should not take that long for them to update.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] btashton commented on pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083#issuecomment-631786611
@patacongo Look correct to me? The coding style document shows the new modified date. Is there something that looks wrong to you?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
patacongo commented on pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083#issuecomment-631790033
> @patacongo Look correct to me? The coding style document shows the new modified date. Is there something that looks wrong to you?
Yes there was, it was showing the old document event after CTRL-Reload. I suppose it just takes a while for things to ripple through. I does look find now. Hmm.. it shows that it was just modified 10 minutes ago. Thanks for whatever you did.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
patacongo commented on pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083#issuecomment-631165668
@btashton This should result in an artifact which is the inlined coding standard document, correct? This document then has to come into Confluence. Do we have a description somwhere on how to do that.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] xiaoxiang781216 merged pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
xiaoxiang781216 merged pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] patacongo commented on pull request #1083: Documentation/NuttXCCodingStandard.html: Fix description of comment on the right
Posted by GitBox <gi...@apache.org>.
patacongo commented on pull request #1083:
URL: https://github.com/apache/incubator-nuttx/pull/1083#issuecomment-631435102
@btashton In this case the style sheet has changed so really all documents should be updated. I won't do that for now.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org