Skip to content

feat[DSS7]: Document SELF_REFRESH and ALWAYS_ON_DISPLAY properties - #760

Open
devarsht wants to merge 1 commit into
TexasInstruments:masterfrom
devarsht:dss_aod_sr
Open

feat[DSS7]: Document SELF_REFRESH and ALWAYS_ON_DISPLAY properties#760
devarsht wants to merge 1 commit into
TexasInstruments:masterfrom
devarsht:dss_aod_sr

Conversation

@devarsht

Copy link
Copy Markdown
Collaborator

Add the SELF_REFRESH (plane) and ALWAYS_ON_DISPLAY (crtc) DRM properties to the tidss properties table, along with usage sections describing their behaviour and modetest examples, following the format used for the other documented properties.

@StaticRocket StaticRocket left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's also some unnecessary use of passive voice in here

Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst Outdated
@SenWang125

Copy link
Copy Markdown
Contributor

Don't have any comments, looks good to me.

Add the SELF_REFRESH (plane) and ALWAYS_ON_DISPLAY (crtc) DRM
properties to the tidss properties table, along with usage
sections describing their behaviour and modetest examples,
following the format used for the other documented properties.

Signed-off-by: Devarsh Thakkar <devarsht@ti.com>
@devarsht

Copy link
Copy Markdown
Collaborator Author

There's also some unnecessary use of passive voice in here

@StaticRocket Yeah but re-reading those sentences which vale reported, those sentences look very much understandable/readable to me and I would prefer to keep that way. But if it's a more popular opinion to always use active voice I can always modify.

@StaticRocket

Copy link
Copy Markdown
Member

Technical documentation is normally declarative and uses active voice. As an example of what I mean: We are dictating the way something behaves under optimal conditions. We are not writing to a friend about something that may or may not happen due to circumstance.

It makes it dry, but brief, easier to translate, and usually easier to understand.

@StaticRocket

Copy link
Copy Markdown
Member

You're also bugging commit-check with that patch formatting

@devarsht

Copy link
Copy Markdown
Collaborator Author

Technical documentation is normally declarative and uses active voice. As an example of what I mean: We are dictating the way something behaves under optimal conditions. We are not writing to a friend about something that may or may not happen due to circumstance.

It makes it dry, but brief, easier to translate, and usually easier to understand.

Hmm, but when describing properties, passive voice is what is mostly what is preferred. See below examples from kernel docs and gstreamer docs:

Kernel docs :
See for e.g. : https://www.kernel.org/doc/html/v4.14/media/uapi/v4l/extended-controls.html?highlight=ignored

For e.g. kernel doc uses passive voice:
V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (integer)
Peak video bitrate in bits per second. Must be larger or equal to the average video bitrate. It is ignored if the video bitrate mode is set to constant bitrate.

And here too:
V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE (integer)
The Coded Picture Buffer size in kilobytes, it is used as a limitation of frame skip

Gstreamer docs:
https://gstreamer.freedesktop.org/documentation/video4linux2/v4l2src.html?gi-language=c

force-aspect-ratio
“force-aspect-ratio” gboolean
When enabled, the pixel aspect ratio queried from the device or set with the pixel-aspect-ratio property will be enforced.

Flags : Read / Write

Default value : true

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants