Skip to contentSkip to conversation

gpu/drm_memory: fix a few warnings

PATCH Superseded Qian Cai 4 participants 7 messages Jul 8, 2019 – Jul 10, 2019

Subsystems (3)

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Qian Cai

author
#0 lore raw

PATCH v2 1/1 gpu/drm_memory: fix a few warnings

The opening comment mark "/**" is reserved for kernel-doc comments, so it will generate a warning with "make W=1".

drivers/gpu/drm/drm_memory.c:2: warning: Cannot understand * \file drm_memory.c

Also, silence a checkpatch warning by adding a license identfiter where it indicates the MIT license further down in the source file.

WARNING: Missing or malformed SPDX-License-Identifier tag in line 1

It becomes redundant to add both an SPDX identifier and have a description of the license in the comment block at the top, so remove the later.

---

v2: remove the redundant description of the license.

 drivers/gpu/drm/drm_memory.c | 22 ++--------------------
 1 file changed, 2 insertions(+), 20 deletions(-)
drivers/gpu/drm/drm_memory.c +2 -20
index 132fef8ff1b6..86a11fc8e954 100644
@@ -1,4 +1,5 @@
-/**
+// SPDX-License-Identifier: MIT
+/*
  * \file drm_memory.c
  * Memory management wrappers for DRM
  *
@@ -12,25 +13,6 @@
  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  * All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the "Software"),
- * to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the next
- * paragraph) shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
- * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
- * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- * OTHER DEALINGS IN THE SOFTWARE.
  */
 
 #include <linux/highmem.h>
Signature · 1 line
1.8.3.1
#1 lore raw
Quoted 45 lines · Qian Cai

The opening comment mark "/**" is reserved for kernel-doc comments, so it will generate a warning with "make W=1".

drivers/gpu/drm/drm_memory.c:2: warning: Cannot understand * \file drm_memory.c

Also, silence a checkpatch warning by adding a license identfiter where it indicates the MIT license further down in the source file.

WARNING: Missing or malformed SPDX-License-Identifier tag in line 1

It becomes redundant to add both an SPDX identifier and have a description of the license in the comment block at the top, so remove the later.

---

v2: remove the redundant description of the license.

 drivers/gpu/drm/drm_memory.c | 22 ++--------------------
 1 file changed, 2 insertions(+), 20 deletions(-)
drivers/gpu/drm/drm_memory.c +2 -7
index 132fef8ff1b6..86a11fc8e954 100644
@@ -1,4 +1,5 @@
-/**
+// SPDX-License-Identifier: MIT
+/*
  * \file drm_memory.c
  * Memory management wrappers for DRM
  *
@@ -12,25 +13,6 @@
  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  * All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the "Software"),
- * to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the

drivers/gpu/drm/drm_memory.c line 30

Quoted 10 lines
drivers/gpu/drm/drm_memory.c +0 -10
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the next
- * paragraph) shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
- * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR

This talks about VA Linux Systems and/or its suppliers, while the MIT licence talks about authors or copyright holders.

Are such transformations OK to just do?

-ilia

Quoted 9 lines
drivers/gpu/drm/drm_memory.c +0 -4
- * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- * OTHER DEALINGS IN THE SOFTWARE.
  */
 
 #include <linux/highmem.h>
--

1.8.3.1

author
#2 lore raw
Quoted 66 lines · Ilia Mirkin
Quoted 53 lines · Qian Cai

The opening comment mark "/**" is reserved for kernel-doc comments, so it will generate a warning with "make W=1".

drivers/gpu/drm/drm_memory.c:2: warning: Cannot understand  * \file drm_memory.c

Also, silence a checkpatch warning by adding a license identfiter where it indicates the MIT license further down in the source file.

WARNING: Missing or malformed SPDX-License-Identifier tag in line 1

It becomes redundant to add both an SPDX identifier and have a description of the license in the comment block at the top, so remove the later.

---

v2: remove the redundant description of the license.

 drivers/gpu/drm/drm_memory.c | 22 ++--------------------

 1 file changed, 2 insertions(+), 20 deletions(-)
drivers/gpu/drm/drm_memory.c +2 -5
index 132fef8ff1b6..86a11fc8e954 100644
@@ -1,4 +1,5 @@
-/**
+// SPDX-License-Identifier: MIT
+/*
   * \file drm_memory.c
   * Memory management wrappers for DRM
   *
@@ -12,25 +13,6 @@
   * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
   * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
   * All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the
 "Software"),
- * to deal in the Software without restriction, including without

limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the next
- * paragraph) shall be included in all copies or substantial portions of the

Quoted 8 lines

- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
- * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR

This talks about VA Linux Systems and/or its suppliers, while the MIT licence talks about authors or copyright holders.

Quoted 1 line

Are such transformations OK to just do?

From,

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Document
ation/process/license-rules.rst

"The Linux kernel requires the precise SPDX identifier in all source files."

That is the closest license I can think of.

Anyway, I have added a few people who may know better of the licensing.

Quoted 12 lines

  -ilia

Quoted 9 lines

- * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
- * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- * OTHER DEALINGS IN THE SOFTWARE.
  */

 #include <linux/highmem.h>
--
1.8.3.1

#3 lore raw
Quoted 28 lines · Qian Cai
Quoted 27 lines · Ilia Mirkin
Quoted 27 lines
drivers/gpu/drm/drm_memory.c +2 -1
-/**
+// SPDX-License-Identifier: MIT
+/*

  * \file drm_memory.c
  * Memory management wrappers for DRM
  *

drivers/gpu/drm/drm_memory.c +0 -4
@@ -12,25 +13,6 @@
   * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
   * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
   * All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the
 "Software"),
- * to deal in the Software without restriction, including without

limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the next
- * paragraph) shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

Quoted 8 lines
Quoted 8 lines
Quoted 5 lines

OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
- * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR

This talks about VA Linux Systems and/or its suppliers, while the MIT licence talks about authors or copyright holders.

That's looks lika a valid substitution and does not change the meaning of the license, AFAICT. Richard might have a differnt opinion though.

Quoted 1 line
Quoted 1 line

Are such transformations OK to just do?

Nope.

Quoted 6 lines

From,

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Document
ation/process/license-rules.rst

"The Linux kernel requires the precise SPDX identifier in all source files."

That's correct.

Quoted 1 line

That is the closest license I can think of.

Well, it's pretty much plain MIT, but you might have noticed:

* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.

So in this case, you need to talk to the copyright holder if he agrees to remove the boiler plate language.

Adding the MIT SPDX identifier without touching the boiler plate is fine.

Thanks,

tglx

#4 lore raw
Quoted 42 lines · Thomas Gleixner
Quoted 28 lines · Qian Cai
Quoted 27 lines · Ilia Mirkin
Quoted 27 lines
drivers/gpu/drm/drm_memory.c +2 -5
-/**
+// SPDX-License-Identifier: MIT
+/*
  * \file drm_memory.c
  * Memory management wrappers for DRM
  *
@@ -12,25 +13,6 @@
  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  * All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the
 "Software"),
- * to deal in the Software without restriction, including without

limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the next
- * paragraph) shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

Quoted 8 lines
Quoted 8 lines
Quoted 5 lines

OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR

This talks about VA Linux Systems and/or its suppliers, while the MIT licence talks about authors or copyright holders.

Quoted 2 lines

That's looks lika a valid substitution and does not change the meaning of the license, AFAICT.

As of the 3.6 release of the SPDX License List, we will have added markup to denote that the name in the disclaimer can be changed and still considered a match. This is a common scenario in other licenses (like the BSD family), but I don’t think we’d come across it until the work on the kernel and adding SPDX identifiers. So, yes, MIT would be the correct SPDX identifier here as of 3.6 (which will be posted in a few days).

For reference, the SPDX License List matching guidelines can be found here: https://spdx.org/spdx-license-list/matching-guidelines - see Guideline 2.1.3 specifically. Replaceable text is marked up in the master files that comprise the SPDX License List according the the XML schema and then displayed in color coded text on the website pages (see, for example, BSD-3-Clause - https://spdx.org/licenses/BSD-3-Clause.html

Of course, if anyone finds any other license text that deserves this kind of accommodation, you can always make a PR here: https://github.com/spdx/license-list-XML :)

thanks,
Jilayne
SPDX legal team co-lead

#5 lore raw
In reply to Thomas Gleixner
Quoted 42 lines · Thomas Gleixner
Quoted 28 lines · Qian Cai
Quoted 27 lines · Ilia Mirkin
Quoted 27 lines
drivers/gpu/drm/drm_memory.c +2 -5
-/**
+// SPDX-License-Identifier: MIT
+/*
  * \file drm_memory.c
  * Memory management wrappers for DRM
  *
@@ -12,25 +13,6 @@
  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  * All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the
 "Software"),
- * to deal in the Software without restriction, including without

limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the next
- * paragraph) shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

Quoted 8 lines
Quoted 8 lines
Quoted 5 lines

OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR

This talks about VA Linux Systems and/or its suppliers, while the MIT licence talks about authors or copyright holders.

Quoted 2 lines

That's looks lika a valid substitution and does not change the meaning of the license, AFAICT.

As of the 3.6 release of the SPDX License List, we will have added markup to denote that the name in the disclaimer can be changed and still considered a match. This is a common scenario in other licenses (like the BSD family), but I don’t think we’d come across it until the work on the kernel and adding SPDX identifiers. So, yes, MIT would be the correct SPDX identifier here as of 3.6 (which will be posted in a few days).

For reference, the SPDX License List matching guidelines can be found here: https://spdx.org/spdx-license-list/matching-guidelines <https://spdx.org/spdx-license-list/matching-guidelines> - see Guideline 2.1.3 specifically. Replaceable text is marked up in the master files that comprise the SPDX License List according the the XML schema and then displayed in color coded text on the website pages (see, for example, BSD-3-Clause - https://spdx.org/licenses/BSD-3-Clause.html <https://spdx.org/licenses/BSD-3-Clause.html>

Of course, if anyone finds any other license text that deserves this kind of accommodation, you can always make a PR here: https://github.com/spdx/license-list-XML <https://github.com/spdx/license-list-XML> :)

thanks,
Jilayne
SPDX legal team co-lead

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel

#6 lore raw
In reply to Thomas Gleixner
Quoted 42 lines · Thomas Gleixner
Quoted 28 lines · Qian Cai
Quoted 27 lines · Ilia Mirkin
Quoted 27 lines
drivers/gpu/drm/drm_memory.c +2 -5
-/**
+// SPDX-License-Identifier: MIT
+/*
  * \file drm_memory.c
  * Memory management wrappers for DRM
  *
@@ -12,25 +13,6 @@
  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  * All Rights Reserved.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the
 "Software"),
- * to deal in the Software without restriction, including without

limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the next
- * paragraph) shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

Quoted 8 lines
Quoted 8 lines
Quoted 5 lines

OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR

This talks about VA Linux Systems and/or its suppliers, while the MIT licence talks about authors or copyright holders.

Quoted 2 lines

That's looks lika a valid substitution and does not change the meaning of the license, AFAICT.

As of the 3.6 release of the SPDX License List, we will have added markup to denote that the name in the disclaimer can be changed and still considered a match. This is a common scenario in other licenses (like the BSD family), but I don’t think we’d come across it until the work on the kernel and adding SPDX identifiers. So, yes, MIT would be the correct SPDX identifier here as of 3.6 (which will be posted in a few days).

For reference, the SPDX License List matching guidelines can be found here: https://spdx.org/spdx-license-list/matching-guidelines <https://spdx.org/spdx-license-list/matching-guidelines> - see Guideline 2.1.3 specifically. Replaceable text is marked up in the master files that comprise the SPDX License List according the the XML schema and then displayed in color coded text on the website pages (see, for example, BSD-3-Clause - https://spdx.org/licenses/BSD-3-Clause.html <https://spdx.org/licenses/BSD-3-Clause.html>

Of course, if anyone finds any other license text that deserves this kind of accommodation, you can always make a PR here: https://github.com/spdx/license-list-XML <https://github.com/spdx/license-list-XML> :)

thanks,
Jilayne
SPDX legal team co-lead

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel