linux-kernel - Re: [PATCH] dma-buf: Add syntax highlighting to code listings in the document

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <af565f2c-1cb3-4ad9-a482-420afc8e6e41@amd.com>
Date: Mon, 23 Sep 2024 16:00:39 +0200
From: Christian König <christian.koenig@....com>
To: Tommy Chiang <ototot@...omium.org>, Sumit Semwal <sumit.semwal@...aro.org>
Cc: linux-media@...r.kernel.org, dri-devel@...ts.freedesktop.org,
 linaro-mm-sig@...ts.linaro.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] dma-buf: Add syntax highlighting to code listings in the
 document

Nothing wrong with this, I just didn't had time to double check it 
myself and then forgotten about it.

Going to push it to drm-misc-next.

Regards,
Christian.


Am 23.09.24 um 11:22 schrieb Tommy Chiang:
> Ping.
> Please let me know if I'm doing something wrong.
>
> On Mon, Feb 19, 2024 at 11:00 AM Tommy Chiang <ototot@...omium.org> wrote:
>> Kindly ping :)
>>
>> On Fri, Jan 19, 2024 at 11:33 AM Tommy Chiang <ototot@...omium.org> wrote:
>>> This patch tries to improve the display of the code listing
>>> on The Linux Kernel documentation website for dma-buf [1] .
>>>
>>> Originally, it appears that it was attempting to escape
>>> the '*' character, but looks like it's not necessary (now),
>>> so we are seeing something like '\*' on the webite.
>>>
>>> This patch removes these unnecessary backslashes and adds syntax
>>> highlighting to improve the readability of the code listing.
>>>
>>> [1] https://docs.kernel.org/driver-api/dma-buf.html
>>>
>>> Signed-off-by: Tommy Chiang <ototot@...omium.org>
>>> ---
>>>   drivers/dma-buf/dma-buf.c | 15 +++++++++------
>>>   1 file changed, 9 insertions(+), 6 deletions(-)
>>>
>>> diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
>>> index 8fe5aa67b167..e083a0ab06d7 100644
>>> --- a/drivers/dma-buf/dma-buf.c
>>> +++ b/drivers/dma-buf/dma-buf.c
>>> @@ -1282,10 +1282,12 @@ EXPORT_SYMBOL_NS_GPL(dma_buf_move_notify, DMA_BUF);
>>>    *   vmap interface is introduced. Note that on very old 32-bit architectures
>>>    *   vmalloc space might be limited and result in vmap calls failing.
>>>    *
>>> - *   Interfaces::
>>> + *   Interfaces:
>>>    *
>>> - *      void \*dma_buf_vmap(struct dma_buf \*dmabuf, struct iosys_map \*map)
>>> - *      void dma_buf_vunmap(struct dma_buf \*dmabuf, struct iosys_map \*map)
>>> + *   .. code-block:: c
>>> + *
>>> + *     void *dma_buf_vmap(struct dma_buf *dmabuf, struct iosys_map *map)
>>> + *     void dma_buf_vunmap(struct dma_buf *dmabuf, struct iosys_map *map)
>>>    *
>>>    *   The vmap call can fail if there is no vmap support in the exporter, or if
>>>    *   it runs out of vmalloc space. Note that the dma-buf layer keeps a reference
>>> @@ -1342,10 +1344,11 @@ EXPORT_SYMBOL_NS_GPL(dma_buf_move_notify, DMA_BUF);
>>>    *   enough, since adding interfaces to intercept pagefaults and allow pte
>>>    *   shootdowns would increase the complexity quite a bit.
>>>    *
>>> - *   Interface::
>>> + *   Interface:
>>> + *
>>> + *   .. code-block:: c
>>>    *
>>> - *      int dma_buf_mmap(struct dma_buf \*, struct vm_area_struct \*,
>>> - *                    unsigned long);
>>> + *     int dma_buf_mmap(struct dma_buf *, struct vm_area_struct *, unsigned long);
>>>    *
>>>    *   If the importing subsystem simply provides a special-purpose mmap call to
>>>    *   set up a mapping in userspace, calling do_mmap with &dma_buf.file will
>>> --
>>> 2.43.0.381.gb435a96ce8-goog
>>>