Skip to contentSkip to conversation

drm/dp_mst: Remove rebase-detritus in VCPI helper kernel-docs

PATCH In review Lyude Paul 2 participants 2 messages Feb 6, 2019 – Feb 7, 2019

Subsystems (2)
lore
Share & tools
lore

Lyude Paul

author
#0 lore raw

PATCH 1/1 drm/dp_mst: Remove rebase-detritus in VCPI helper kernel-docs

Looks like when making the final revision of:

022debad063e ("drm/atomic: Add drm_atomic_state->duplicated")

I forgot to remove some of the comments that I had added to drm_dp_atomic_find_vcpi_slots() and drm_dp_atomic_release_vcpi_slots() that were no longer valid due to us having removed the state->duplicated checks from each function. This also introduced an error while building the docs with sphinx:

./drivers/gpu/drm/drm_dp_mst_topology.c:3100: WARNING: Inline literal start-string without end-string.

So, fix that by just removing the kerneldoc comments.

Fixes 022debad063e ("drm/atomic: Add drm_atomic_state->duplicated")
Cc Daniel Vetter <[email protected]>
---
 drivers/gpu/drm/drm_dp_mst_topology.c | 9 ---------
 1 file changed, 9 deletions(-)
drivers/gpu/drm/drm_dp_mst_topology.c +0 -9
index 5a99135d39cd..dc7ac0c60547 100644
@@ -3097,10 +3097,6 @@ static int drm_dp_init_vcpi(struct drm_dp_mst_topology_mgr *mgr,
  * @port as needed. It is not OK however, to call this function and
  * drm_dp_atomic_release_vcpi_slots() in the same atomic check phase.
  *
- * When &drm_atomic_state.duplicated is set to %true%, this function will not
- * perform any error checking and will instead simply return the previously
- * recorded VCPI allocations.
- *
  * See also:
  * drm_dp_atomic_release_vcpi_slots()
  * drm_dp_mst_atomic_check()
@@ -3185,11 +3181,6 @@ EXPORT_SYMBOL(drm_dp_atomic_find_vcpi_slots);
  * drm_dp_atomic_find_vcpi_slots() on the same @port in a single atomic check
  * phase.
  *
- * When &drm_atomic_state.duplicated is set, this function will not
- * modify the VCPI allocations in &drm_dp_mst_topology_state.vcpis, so that
- * those VCPI allocations may be restored as-is from the duplicated state. In
- * this scenario, this function will always return 0.
- *
  * See also:
  * drm_dp_atomic_find_vcpi_slots()
  * drm_dp_mst_atomic_check()
Signature · 1 line
2.20.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 10 lines · Lyude Paul

Looks like when making the final revision of:

022debad063e ("drm/atomic: Add drm_atomic_state->duplicated")

I forgot to remove some of the comments that I had added to drm_dp_atomic_find_vcpi_slots() and drm_dp_atomic_release_vcpi_slots() that were no longer valid due to us having removed the state->duplicated checks from each function. This also introduced an error while building the docs with sphinx:

Quoted 6 lines

./drivers/gpu/drm/drm_dp_mst_topology.c:3100: WARNING: Inline literal start-string without end-string.

So, fix that by just removing the kerneldoc comments.

Quoted 36 lines
Fixes 022debad063e ("drm/atomic: Add drm_atomic_state->duplicated")
Cc Daniel Vetter <[email protected]>
---
 drivers/gpu/drm/drm_dp_mst_topology.c | 9 ---------
 1 file changed, 9 deletions(-)
drivers/gpu/drm/drm_dp_mst_topology.c +0 -9
index 5a99135d39cd..dc7ac0c60547 100644
@@ -3097,10 +3097,6 @@ static int drm_dp_init_vcpi(struct drm_dp_mst_topology_mgr *mgr,
  * @port as needed. It is not OK however, to call this function and
  * drm_dp_atomic_release_vcpi_slots() in the same atomic check phase.
  *
- * When &drm_atomic_state.duplicated is set to %true%, this function will not
- * perform any error checking and will instead simply return the previously
- * recorded VCPI allocations.
- *
  * See also:
  * drm_dp_atomic_release_vcpi_slots()
  * drm_dp_mst_atomic_check()
@@ -3185,11 +3181,6 @@ EXPORT_SYMBOL(drm_dp_atomic_find_vcpi_slots);
  * drm_dp_atomic_find_vcpi_slots() on the same @port in a single atomic check
  * phase.
  *
- * When &drm_atomic_state.duplicated is set, this function will not
- * modify the VCPI allocations in &drm_dp_mst_topology_state.vcpis, so that
- * those VCPI allocations may be restored as-is from the duplicated state. In
- * this scenario, this function will always return 0.
- *
  * See also:
  * drm_dp_atomic_find_vcpi_slots()
  * drm_dp_mst_atomic_check()
Signature · 1 line
2.20.1
Signature · 1 line
Sean Paul, Software Engineer, Google / Chromium OS