Re: [PATCH] drm: Trivial comment grammar cleanups

On Fri, Feb 01, 2019 at 05:23:26PM -0800, Matt Roper wrote:

Most of these are just cases where code comments used contractions (it's, who's) where they actually mean to use a possessive pronoun (its, whose) or vice-versa.

Signed-off-by: Matt Roper matthew.d.roper@intel.com

A couple of these were bugging me enough that I did a quick search for other similar mistakes in the DRM core. I'm sure there are plenty more in the various driver trees that could be cleaned up if someone wanted to spend the time to track them down.

Someone reading the docs, yay! Thanks for the patch, applied to drm-misc-next. -Daniel

drivers/gpu/drm/drm_agpsupport.c | 2 +- drivers/gpu/drm/drm_atomic_helper.c | 8 ++++---- drivers/gpu/drm/drm_atomic_uapi.c | 4 ++-- drivers/gpu/drm/drm_bufs.c | 4 ++-- drivers/gpu/drm/drm_connector.c | 2 +- drivers/gpu/drm/drm_dp_mst_topology.c | 30 +++++++++++++++--------------- drivers/gpu/drm/drm_fb_helper.c | 2 +- drivers/gpu/drm/drm_file.c | 2 +- drivers/gpu/drm/drm_framebuffer.c | 2 +- drivers/gpu/drm/drm_gem.c | 2 +- drivers/gpu/drm/drm_mm.c | 2 +- drivers/gpu/drm/drm_modes.c | 2 +- drivers/gpu/drm/drm_property.c | 2 +- drivers/gpu/drm/drm_vblank.c | 2 +- include/drm/drm_atomic.h | 2 +- include/drm/drm_client.h | 2 +- include/drm/drm_connector.h | 2 +- include/drm/drm_mode_config.h | 2 +- include/drm/drm_modeset_helper_vtables.h | 2 +- include/drm/drm_modeset_lock.h | 2 +- include/drm/ttm/ttm_bo_driver.h | 2 +- 21 files changed, 40 insertions(+), 40 deletions(-)

diff --git a/drivers/gpu/drm/drm_agpsupport.c b/drivers/gpu/drm/drm_agpsupport.c index 737f02885c28..40fba1c04dfc 100644 --- a/drivers/gpu/drm/drm_agpsupport.c +++ b/drivers/gpu/drm/drm_agpsupport.c @@ -348,7 +348,7 @@ int drm_agp_bind_ioctl(struct drm_device *dev, void *data,

• \return zero on success or a negative number on failure.
• Verifies the AGP device is present and has been acquired and looks up the

• • AGP memory entry. If the memory it's currently bound, unbind it via

• • AGP memory entry. If the memory is currently bound, unbind it via
  • unbind_agp(). Frees it via free_agp() as well as the entry itself
  • and unlinks from the doubly linked list it's inserted in.
  */

diff --git a/drivers/gpu/drm/drm_atomic_helper.c b/drivers/gpu/drm/drm_atomic_helper.c index 6fe2303fccd9..440cfa91162a 100644 --- a/drivers/gpu/drm/drm_atomic_helper.c +++ b/drivers/gpu/drm/drm_atomic_helper.c @@ -330,7 +330,7 @@ update_connector_routing(struct drm_atomic_state *state, * Since the connector can be unregistered at any point during an * atomic check or commit, this is racy. But that's OK: all we care * about is ensuring that userspace can't do anything but shut off the

• * display on a connector that was destroyed after its been notified,
  

• * display on a connector that was destroyed after it's been notified,
  

  • not before.
  */ if (drm_connector_is_unregistered(connector) && crtc_state->active) {

@@ -685,7 +685,7 @@ drm_atomic_helper_check_modeset(struct drm_device *dev,

/* * After all the routing has been prepared we need to add in any

• * connector which is itself unchanged, but who's crtc changes it's
  

• * connector which is itself unchanged, but whose crtc changes its
  

  • configuration. This must be done before calling mode_fixup in case a
  • crtc only changed its mode but has the same set of connectors.
  */

@@ -1670,7 +1670,7 @@ EXPORT_SYMBOL(drm_atomic_helper_async_commit);

• drm_atomic_helper_setup_commit() and related functions.
• Committing the actual hardware state is done through the

• • &drm_mode_config_helper_funcs.atomic_commit_tail callback, or it's default

• • &drm_mode_config_helper_funcs.atomic_commit_tail callback, or its default
  • implementation drm_atomic_helper_commit_tail().
  • RETURNS:

@@ -1893,7 +1893,7 @@ crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)

• functions. drm_atomic_helper_wait_for_dependencies() must be called before
• actually committing the hardware state, and for nonblocking commits this call
• must be placed in the async worker. See also drm_atomic_helper_swap_state()

• • and it's stall parameter, for when a driver's commit hooks look at the

• • and its stall parameter, for when a driver's commit hooks look at the
  • &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
  • Completion of the hardware commit step must be signalled using

diff --git a/drivers/gpu/drm/drm_atomic_uapi.c b/drivers/gpu/drm/drm_atomic_uapi.c index 9a1f41adfc67..0aabd401d3ca 100644 --- a/drivers/gpu/drm/drm_atomic_uapi.c +++ b/drivers/gpu/drm/drm_atomic_uapi.c @@ -44,8 +44,8 @@

• DOC: overview
• This file contains the marshalling and demarshalling glue for the atomic UAPI

• • in all it's form: The monster ATOMIC IOCTL itself, code for GET_PROPERTY and
• • SET_PROPERTY IOCTls. Plus interface functions for compatibility helpers and

• • in all its forms: The monster ATOMIC IOCTL itself, code for GET_PROPERTY and
• • SET_PROPERTY IOCTLs. Plus interface functions for compatibility helpers and
  • drivers which have special needs to construct their own atomic updates, e.g.
  • for load detect or similiar.
  */

diff --git a/drivers/gpu/drm/drm_bufs.c b/drivers/gpu/drm/drm_bufs.c index a39ab2193bfe..e407adb033e7 100644 --- a/drivers/gpu/drm/drm_bufs.c +++ b/drivers/gpu/drm/drm_bufs.c @@ -494,7 +494,7 @@ int drm_legacy_getmap_ioctl(struct drm_device *dev, void *data,

• isn't in use.
• Searches the map on drm_device::maplist, removes it from the list, see if

• • its being used, and free any associate resource (such as MTRR's) if it's not

• • it's being used, and free any associated resource (such as MTRR's) if it's not
  • being on use.
  • \sa drm_legacy_addmap

@@ -621,7 +621,7 @@ int drm_legacy_rmmap_ioctl(struct drm_device *dev, void *data, } }

• /* List has wrapped around to the head pointer, or its empty we didn't

• /* List has wrapped around to the head pointer, or it's empty we didn't
  • find anything.
  */ if (list_empty(&dev->maplist) || !map) {

diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c index e3ff73695c32..dd40eff0911c 100644 --- a/drivers/gpu/drm/drm_connector.c +++ b/drivers/gpu/drm/drm_connector.c @@ -1066,7 +1066,7 @@ EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);

• content type (HDMI specific):
• Indicates content type setting to be used in HDMI infoframes to indicate

• • content type for the external device, so that it adjusts it's display

• • content type for the external device, so that it adjusts its display
  • settings accordingly.
  • The value of this property can be one of the following:

diff --git a/drivers/gpu/drm/drm_dp_mst_topology.c b/drivers/gpu/drm/drm_dp_mst_topology.c index b1c63e9cdf8a..6d0d8e01f16e 100644 --- a/drivers/gpu/drm/drm_dp_mst_topology.c +++ b/drivers/gpu/drm/drm_dp_mst_topology.c @@ -941,7 +941,7 @@ static void drm_dp_free_mst_branch_device(struct kref *kref)

• in-memory topology state from being changed in the middle of critical
• operations like changing the internal state of payload allocations. This
• means each branch and port will be considered to be connected to the rest

• • of the topology until it's topology refcount reaches zero. Additionally,

• • of the topology until its topology refcount reaches zero. Additionally,
  • for ports this means that their associated &struct drm_connector will stay
  • registered with userspace until the port's refcount reaches 0.

@@ -979,8 +979,8 @@ static void drm_dp_free_mst_branch_device(struct kref *kref)

• same way as the C pointers used to reference a structure.
• As you can see in the above figure, every branch increments the topology

• • refcount of it's children, and increments the malloc refcount of it's
• • parent. Additionally, every payload increments the malloc refcount of it's

• • refcount of its children, and increments the malloc refcount of its
• • parent. Additionally, every payload increments the malloc refcount of its
  • assigned port by 1.
  • So, what would happen if MSTB #3 from the above figure was unplugged from

@@ -997,9 +997,9 @@ static void drm_dp_free_mst_branch_device(struct kref *kref)

• of its parent, and finally its own malloc refcount. For MSTB #4 and port
• #4, this means they both have been disconnected from the topology and freed
• from memory. But, because payload #2 is still holding a reference to port

• • #3, port #3 is removed from the topology but it's &struct drm_dp_mst_port

• • #3, port #3 is removed from the topology but its &struct drm_dp_mst_port
  • is still accessible from memory. This also means port #3 has not yet

• • decremented the malloc refcount of MSTB #3, so it's &struct

• • decremented the malloc refcount of MSTB #3, so its &struct
  • drm_dp_mst_branch will also stay allocated in memory until port #3's
  • malloc refcount reaches 0.

@@ -1139,7 +1139,7 @@ static void drm_dp_destroy_mst_branch_device(struct kref *kref)

/**

• drm_dp_mst_topology_try_get_mstb() - Increment the topology refcount of a

• • branch device unless its zero

• • branch device unless it's zero
  • @mstb: &struct drm_dp_mst_branch to increment the topology refcount of
  • Attempts to grab a topology reference to @mstb, if it hasn't yet been

@@ -1265,7 +1265,7 @@ static void drm_dp_destroy_port(struct kref *kref)

/**

• drm_dp_mst_topology_try_get_port() - Increment the topology refcount of a

• • port unless its zero

• • port unless it's zero
  • @port: &struct drm_dp_mst_port to increment the topology refcount of
  • Attempts to grab a topology reference to @port, if it hasn't yet been

@@ -1471,7 +1471,7 @@ static bool drm_dp_port_setup_pdt(struct drm_dp_mst_port *port) port->mstb->port_parent = port; /* * Make sure this port's memory allocation stays

• 	 * around until it's child MSTB releases it
  

• 	 * around until its child MSTB releases it
   */
  drm_dp_mst_get_port_malloc(port);
  
  

@@ -2271,7 +2271,7 @@ static int drm_dp_destroy_payload_step1(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_payload *payload) { DRM_DEBUG_KMS("\n");

• /* its okay for these to fail */

• /* it's okay for these to fail */ if (port) { drm_dp_payload_send_msg(mgr, port, id, 0); }

@@ -2947,7 +2947,7 @@ enum drm_connector_status drm_dp_mst_detect_port(struct drm_connector *connector { enum drm_connector_status status = connector_status_disconnected;

• /* we need to search for the port in the mgr in case its gone */

• /* we need to search for the port in the mgr in case it's gone */ port = drm_dp_mst_topology_get_port_validated(mgr, port); if (!port) return connector_status_disconnected;

@@ -3013,7 +3013,7 @@ struct edid *drm_dp_mst_get_edid(struct drm_connector *connector, struct drm_dp_ { struct edid *edid = NULL;

• /* we need to search for the port in the mgr in case its gone */

• /* we need to search for the port in the mgr in case it's gone */ port = drm_dp_mst_topology_get_port_validated(mgr, port); if (!port) return NULL;

@@ -3180,7 +3180,7 @@ EXPORT_SYMBOL(drm_dp_atomic_find_vcpi_slots);

• Releases any VCPI slots that have been allocated to a port in the atomic
• state. Any atomic drivers which support MST must call this function in
• their &drm_connector_helper_funcs.atomic_check() callback when the

• • connector will no longer have VCPI allocated (e.g. because it's CRTC was

• • connector will no longer have VCPI allocated (e.g. because its CRTC was
  • removed) when it had VCPI allocated in the previous atomic state.
  • It is OK to call this even if @port has been removed from the system.

@@ -3268,7 +3268,7 @@ bool drm_dp_mst_allocate_vcpi(struct drm_dp_mst_topology_mgr *mgr, DRM_DEBUG_KMS("initing vcpi for pbn=%d slots=%d\n", pbn, port->vcpi.num_slots);

• /* Keep port allocated until it's payload has been removed */

• /* Keep port allocated until its payload has been removed */ drm_dp_mst_get_port_malloc(port); drm_dp_mst_topology_put_port(port); return true;

@@ -3300,7 +3300,7 @@ EXPORT_SYMBOL(drm_dp_mst_get_vcpi_slots); void drm_dp_mst_reset_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port) { /*

• * A port with VCPI will remain allocated until it's VCPI is
  

• * A port with VCPI will remain allocated until its VCPI is
  

  • released, no verified ref needed
  */

@@ -3317,7 +3317,7 @@ void drm_dp_mst_deallocate_vcpi(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port) { /*

• * A port with VCPI will remain allocated until it's VCPI is
  

• * A port with VCPI will remain allocated until its VCPI is
  

  • released, no verified ref needed
  */

diff --git a/drivers/gpu/drm/drm_fb_helper.c b/drivers/gpu/drm/drm_fb_helper.c index 145c00ac58ce..0e9349ff2d16 100644 --- a/drivers/gpu/drm/drm_fb_helper.c +++ b/drivers/gpu/drm/drm_fb_helper.c @@ -2508,7 +2508,7 @@ static int drm_pick_crtcs(struct drm_fb_helper *fb_helper, /*

• This function checks if rotation is necessary because of panel orientation
• and if it is, if it is supported.

• • If rotation is necessary and supported, its gets set in fb_crtc.rotation.

• • If rotation is necessary and supported, it gets set in fb_crtc.rotation.
  • If rotation is necessary but not supported, a DRM_MODE_ROTATE_* flag gets
  • or-ed into fb_helper->sw_rotations. In drm_setup_crtcs_fb() we check if only
  • one bit is set and then we set fb_info.fbcon_rotate_hint to make fbcon do

diff --git a/drivers/gpu/drm/drm_file.c b/drivers/gpu/drm/drm_file.c index 46f48f245eb5..b1838a41ad43 100644 --- a/drivers/gpu/drm/drm_file.c +++ b/drivers/gpu/drm/drm_file.c @@ -701,7 +701,7 @@ int drm_event_reserve_init(struct drm_device *dev, EXPORT_SYMBOL(drm_event_reserve_init);

/**

• • drm_event_cancel_free - free a DRM event and release it's space

• • drm_event_cancel_free - free a DRM event and release its space
  • @dev: DRM device
  • @p: tracking structure for the pending event

diff --git a/drivers/gpu/drm/drm_framebuffer.c b/drivers/gpu/drm/drm_framebuffer.c index 7abcb265a108..d8d75e25f6fb 100644 --- a/drivers/gpu/drm/drm_framebuffer.c +++ b/drivers/gpu/drm/drm_framebuffer.c @@ -773,7 +773,7 @@ EXPORT_SYMBOL(drm_framebuffer_lookup);

• @fb: fb to unregister
• Drivers need to call this when cleaning up driver-private framebuffers, e.g.

• • those used for fbdev. Note that the caller must hold a reference of it's own,

• • those used for fbdev. Note that the caller must hold a reference of its own,
  • i.e. the object may not be destroyed through this call (since it'll lead to a
  • locking inversion).

diff --git a/drivers/gpu/drm/drm_gem.c b/drivers/gpu/drm/drm_gem.c index 2896ff60552f..d0b9f6a9953f 100644 --- a/drivers/gpu/drm/drm_gem.c +++ b/drivers/gpu/drm/drm_gem.c @@ -660,7 +660,7 @@ void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages, EXPORT_SYMBOL(drm_gem_put_pages);

/**

• • drm_gem_object_lookup - look up a GEM object from it's handle

• • drm_gem_object_lookup - look up a GEM object from its handle
  • @filp: DRM file private date
  • @handle: userspace handle

diff --git a/drivers/gpu/drm/drm_mm.c b/drivers/gpu/drm/drm_mm.c index 3cc5fbd78ee2..2b4f373736c7 100644 --- a/drivers/gpu/drm/drm_mm.c +++ b/drivers/gpu/drm/drm_mm.c @@ -816,7 +816,7 @@ EXPORT_SYMBOL(drm_mm_scan_add_block);

• When the scan list is empty, the selected memory nodes can be freed. An
• immediately following drm_mm_insert_node_in_range_generic() or one of the
• simpler versions of that function with !DRM_MM_SEARCH_BEST will then return

• • the just freed block (because its at the top of the free_stack list).

• • the just freed block (because it's at the top of the free_stack list).
  • Returns:
  • True if this block should be evicted, false otherwise. Will always

diff --git a/drivers/gpu/drm/drm_modes.c b/drivers/gpu/drm/drm_modes.c index 59b92b1a396b..869ac6f4671e 100644 --- a/drivers/gpu/drm/drm_modes.c +++ b/drivers/gpu/drm/drm_modes.c @@ -1272,7 +1272,7 @@ const char *drm_get_mode_status_name(enum drm_mode_status status)

• @verbose: be verbose about it
• This helper function can be used to prune a display mode list after

• • validation has been completed. All modes who's status is not MODE_OK will be

• • validation has been completed. All modes whose status is not MODE_OK will be
  • removed from the list, and if @verbose the status code and mode name is also
  • printed to dmesg.
  */

diff --git a/drivers/gpu/drm/drm_property.c b/drivers/gpu/drm/drm_property.c index 79c77c3cad86..f8ec8f9c3e7a 100644 --- a/drivers/gpu/drm/drm_property.c +++ b/drivers/gpu/drm/drm_property.c @@ -866,7 +866,7 @@ int drm_mode_destroyblob_ioctl(struct drm_device *dev,

• value doesn't become invalid part way through the property update due to
• race). The value returned by reference via 'obj' should be passed back
• to drm_property_change_valid_put() after the property is set (and the

• • object to which the property is attached has a chance to take it's own

• • object to which the property is attached has a chance to take its own
  • reference).
  */

bool drm_property_change_valid_get(struct drm_property *property, diff --git a/drivers/gpu/drm/drm_vblank.c b/drivers/gpu/drm/drm_vblank.c index cde71ee95a8f..a1b65d26d761 100644 --- a/drivers/gpu/drm/drm_vblank.c +++ b/drivers/gpu/drm/drm_vblank.c @@ -48,7 +48,7 @@

• Drivers must initialize the vertical blanking handling core with a call to
• drm_vblank_init(). Minimally, a driver needs to implement
• &drm_crtc_funcs.enable_vblank and &drm_crtc_funcs.disable_vblank plus call

• • drm_crtc_handle_vblank() in it's vblank interrupt handler for working vblank

• • drm_crtc_handle_vblank() in its vblank interrupt handler for working vblank
  • support.
  • Vertical blanking interrupts can be enabled by the DRM core or by drivers

diff --git a/include/drm/drm_atomic.h b/include/drm/drm_atomic.h index 811b4a92568f..3b97b2bfaad9 100644 --- a/include/drm/drm_atomic.h +++ b/include/drm/drm_atomic.h @@ -192,7 +192,7 @@ struct drm_private_state;

• private objects. The structure itself is used as a vtable to identify the
• associated private object type. Each private object type that needs to be
• added to the atomic states is expected to have an implementation of these

• • hooks and pass a pointer to it's drm_private_state_funcs struct to

• • hooks and pass a pointer to its drm_private_state_funcs struct to
  • drm_atomic_get_private_obj_state().
  */

struct drm_private_state_funcs { diff --git a/include/drm/drm_client.h b/include/drm/drm_client.h index 971bb7853776..8b552b1a6ce9 100644 --- a/include/drm/drm_client.h +++ b/include/drm/drm_client.h @@ -26,7 +26,7 @@ struct drm_client_funcs { * @unregister: * * Called when &drm_device is unregistered. The client should respond by

• * releasing it's resources using drm_client_release().
  

• * releasing its resources using drm_client_release().
  

  • This callback is optional.
  */

diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h index 994161374a49..8fe22abb1e10 100644 --- a/include/drm/drm_connector.h +++ b/include/drm/drm_connector.h @@ -912,7 +912,7 @@ struct drm_connector { /** * @ycbcr_420_allowed : This bool indicates if this connector is * capable of handling YCBCR 420 output. While parsing the EDID

• * blocks, its very helpful to know, if the source is capable of
  

• * blocks it's very helpful to know if the source is capable of
  

  • handling YCBCR 420 outputs.
  */ bool ycbcr_420_allowed;

diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h index 1e6cb885994d..7f60e8eb269a 100644 --- a/include/drm/drm_mode_config.h +++ b/include/drm/drm_mode_config.h @@ -361,7 +361,7 @@ struct drm_mode_config { * * This is the big scary modeset BKL which protects everything that * isn't protect otherwise. Scope is unclear and fuzzy, try to remove

• * anything from under it's protection and move it into more well-scoped
  

• * anything from under its protection and move it into more well-scoped
  

  • locks.
  • The one important thing this protects is the use of @acquire_ctx.

diff --git a/include/drm/drm_modeset_helper_vtables.h b/include/drm/drm_modeset_helper_vtables.h index 61142aa0ab23..cfb7be40bed7 100644 --- a/include/drm/drm_modeset_helper_vtables.h +++ b/include/drm/drm_modeset_helper_vtables.h @@ -1013,7 +1013,7 @@ struct drm_plane_helper_funcs { * @prepare_fb: * * This hook is to prepare a framebuffer for scanout by e.g. pinning

• * it's backing storage or relocating it into a contiguous block of
  

• * its backing storage or relocating it into a contiguous block of
  

  • VRAM. Other possible preparatory work includes flushing caches.
  • This function must not block for outstanding rendering, since it is

diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h index a308f2d6496f..7b8841065b11 100644 --- a/include/drm/drm_modeset_lock.h +++ b/include/drm/drm_modeset_lock.h @@ -68,7 +68,7 @@ struct drm_modeset_acquire_ctx { /**

• struct drm_modeset_lock - used for locking modeset resources.
• @mutex: resource locking

• • @head: used to hold it's place on &drm_atomi_state.locked list when

• • @head: used to hold its place on &drm_atomi_state.locked list when
  • part of an atomic update
  • Used for locking CRTCs and other modeset resources.

diff --git a/include/drm/ttm/ttm_bo_driver.h b/include/drm/ttm/ttm_bo_driver.h index 15829b24277c..cbf3180cb612 100644 --- a/include/drm/ttm/ttm_bo_driver.h +++ b/include/drm/ttm/ttm_bo_driver.h @@ -876,7 +876,7 @@ int ttm_bo_pipeline_move(struct ttm_buffer_object *bo,

• @bo: A pointer to a struct ttm_buffer_object.

• • Pipelined gutting a BO of it's backing store.

• • Pipelined gutting a BO of its backing store.
  */

int ttm_bo_pipeline_gutting(struct ttm_buffer_object *bo);

-- 2.14.5

---

dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel