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/09/02 19:11:52 UTC
[GitHub] [incubator-nuttx] v01d opened a new pull request #1699: documentation: fix build warning
v01d opened a new pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699
## Summary
Use correct highlight setting for block of assembly in nxflat.rst, which generated a warning.
## Impact
Documentation
## Testing
Builds with no warning
----------------------------------------------------------------
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] v01d commented on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685985421
I'm not sure what rendered docs you are referring to. I can see it correctly here: https://nuttx.apache.org/docs/latest/components/nxflat.html#appendix-a-no-got-operation
It also look OK locally.
----------------------------------------------------------------
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] v01d commented on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685990837
This seems to be more about the editor correctly parsing RST or not. If I add the extra line, vim does not color correctly the block, it only works if it starts indented as you suggest. Starting with a label should take care of it. Do you want to make a PR?
----------------------------------------------------------------
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] v01d commented on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685987622
L1 appears highlighted:
BTW, shouldn't it be "L1:" (colon missing?)
----------------------------------------------------------------
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 #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685988730
The issue is the the code block is delimited by the indentation, if we add two empty spaces on the first line it is fine, Perhaps a comment so editors do not strip 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] v01d commented on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685986191
The only strange thing I can see is that `.word` has a different color, but I'm not sure if that is OK or not. Also, `#0` is indeed italicized but my guess is it does not like the `#`
----------------------------------------------------------------
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 #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685990977
Ahh. I take it back, I was seeing a cached version. I do think my local editor is confused by the lack of proper indent on the start, but that is my editor not sphinx....
----------------------------------------------------------------
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] v01d commented on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685971962
I just rebased and warning no longer appears.
----------------------------------------------------------------
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 edited a comment on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton edited a comment on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685990093
> L1 appears highlighted:
Not in the rendered output. Notice how the comments are also not highlighted.
>
> BTW, shouldn't it be "L1:" (colon missing?)
Yes
----------------------------------------------------------------
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] v01d commented on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685948556
We can wait. I'll rebase once the other PR finishes CI and I can merge 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] btashton commented on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-686087627
@v01d the poor rendering of `#0` bothered me so I opened a PR to fix it in pygments so hopefully the next release will fix this. https://github.com/pygments/pygments/pull/1530
Sorry for all the noise on the other issue. I thought I had forced my browser to clear its cache.
----------------------------------------------------------------
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 merged pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton merged pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699
----------------------------------------------------------------
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] v01d commented on pull request #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685991434
> > L1 appears highlighted:
>
> Not in the rendered output. Notice how the comments are also not highlighted.
> 
>
> > BTW, shouldn't it be "L1:" (colon missing?)
>
> Yes
Where is that from? What is "rendered output" for you? I took a screenshot of documentation on the nuttx website.
----------------------------------------------------------------
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 #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685981898
@v01d I noticed another issue in the rendered docs
```
.. code-block:: asm
ldr r1, .L0 /* Fetch the offset to 'x' */
ldr r0, [r10, r1] /* Load the value of 'x' with PIC offset */
/* ... */
.L0: .word x /* Offset to 'x' */
```
this does not work correctly because the .L0 is on a different level than the start of the code block. The rest of the page then is not quite rendered correctly. I see in my text editor everything becomes italicised indicating a special mode. You see this in the rendered docs as the second code block is not highlighted.
This renders correctly.
```
.. code-block:: asm
.FOO
ldr r1, .L0 /* Fetch the offset to 'x' */
ldr r0, [r10, r1] /* Load the value of 'x' with PIC offset */
/* ... */
.L0: .word x /* Offset to 'x' */
```
----------------------------------------------------------------
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 #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685948011
@v01d do you want me to merge this in now, or should we do it on top of my change?
----------------------------------------------------------------
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 #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685990093
> L1 appears highlighted:
Not in the rendered output. Notice how the comments are also not highlighted.
>
> BTW, shouldn't it be "L1:" (colon missing?)
Yes
----------------------------------------------------------------
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 #1699: documentation: fix build warning
Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1699:
URL: https://github.com/apache/incubator-nuttx/pull/1699#issuecomment-685986426
> I'm not sure what rendered docs you are referring to. I can see it correctly here: https://nuttx.apache.org/docs/latest/components/nxflat.html#appendix-a-no-got-operation
> It also look OK locally.
Notice how the L1 in the next section is not highlighted.
And in my editor:
----------------------------------------------------------------
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