Skip to contentSkip to conversation

staging: sm750: Rename function to avoid CamelCase

PATCH Kloudifold 5 participants 6 messages Mar 15, 2023 – Mar 18, 2023 Staging

lore
Share & tools
lore

Kloudifold

author
#0 lore raw

Hi Alison,

Thanks a lot for your help, so if I send my v3 patch, should it be like below? (Philipp said "please make the Subject more unique", but the Subject could be only a few permutations of very few words, I can't see how it could be any more unique.)

Subject: [PATCH v2] staging: sm750: Rename functions from CamelCase to snake case

sm750 driver has sm750_hw_cursor_* functions, which are named in camelcase. Rename them to snake case to follow the function naming convention.

Changes in v3:
- Add this changelog (Philipp)
- Move lkp tags and link to the correct location in commit log (Alison)
- Update the commit msg (Philip)
- Update the commit log (Bagas, Julia)

Changes in v2:
- Use new function names in call sites (LKP)

| Reported-by: kernel test robot <[email protected]>
| Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/
---
git diff message
---

#1 lore raw
Quoted 13 lines · Kloudifold

Hi Alison,

Thanks a lot for your help, so if I send my v3 patch, should it be like below? (Philipp said "please make the Subject more unique", but the Subject could be only a few permutations of very few words, I can't see how it could be any more unique.)

Subject: [PATCH v2] staging: sm750: Rename functions from CamelCase to snake case

sm750 driver has sm750_hw_cursor_* functions, which are named in camelcase. Rename them to snake case to follow the function naming convention.

Quoted 8 lines

Changes in v3:
- Add this changelog (Philipp)
- Move lkp tags and link to the correct location in commit log (Alison)
- Update the commit msg (Philip)
- Update the commit log (Bagas, Julia)

Changes in v2:
- Use new function names in call sites (LKP)

All these changes should go below the --- line, not above it like this. The history of changes is for people who are following along in the email discussion. Once the patch is accepted, they won't be meaningful. So they should be the in the part that disappears, which is the part below the ---.

julia

Quoted 9 lines

| Reported-by: kernel test robot <[email protected]>
| Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/
---
git diff message
---

#2 lore raw
In reply to Kloudifold
Quoted 7 lines · Kloudifold

Hi Alison,

Thanks a lot for your help, so if I send my v3 patch, should it be like below? (Philipp said "please make the Subject more unique", but the Subject could be only a few permutations of very few words, I can't see how it could be any more unique.)

Quoted 5 lines

Subject: [PATCH v2] staging: sm750: Rename functions from CamelCase to snake case

sm750 driver has sm750_hw_cursor_* functions, which are named in camelcase. Rename them to snake case to follow the function naming convention.

You may want to review similar patches submitted in the past by the developers and get hints on how it was named then. Use it to improve your understanding, let your own thoughtfulness prevail.

https://lore.kernel.org/?q=&a=search+all+inboxes

Thanks,
Deepak.

Quoted 17 lines

Changes in v3:
- Add this changelog (Philipp)
- Move lkp tags and link to the correct location in commit log (Alison)
- Update the commit msg (Philip)
- Update the commit log (Bagas, Julia)

Changes in v2:
- Use new function names in call sites (LKP)

| Reported-by: kernel test robot <[email protected]>
| Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/
---
git diff message
---

#3 lore raw
In reply to Kloudifold
Quoted 1 line · Kloudifold

Subject: [PATCH v2] staging: sm750: Rename functions from CamelCase to snake case

If I only see the subject above, which functions are renamed? I have to see the actual diff if the patch description doesn't answer that. In this case, I think the proper subject would be `[PATCH v3] staging:
sm750: Rename sm750_hw_cursor_* functions to snake_case`.

Quoted 2 lines

| Reported-by: kernel test robot <[email protected]>
| Link: https://lore.kernel.org/oe-kbuild-all/[email protected]/

kernel test robot (lkp) reported errors on your submitted patch, not on commits already in the tree, so both Reported-by: and Link: trailers above are not appropriate.

If you want to add trailers from someone else (like kernel test robot above), you just need to write e.g. (ignore markdown):

```
Link: <link>
Reported-by: <identity>
Tested-by: <identity>
```

In other words, trim the preceding ``| ``.

See you in v3!

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#4 lore raw
Quoted 7 lines · Bagas Sanjaya
Quoted 1 line · Kloudifold

Subject: [PATCH v2] staging: sm750: Rename functions from CamelCase to snake case

If I only see the subject above, which functions are renamed? I have to see the actual diff if the patch description doesn't answer that. In this case, I think the proper subject would be `[PATCH v3] staging:
sm750: Rename sm750_hw_cursor_* functions to snake_case`.

No. The oneliner is a brief overview.

It is perfectly appropriate to have to look at the diff to see what was done. The commit message is to state what the problem was and how it was fixed.

Ira

#5 lore raw
Quoted 9 lines · Ira Weiny
Quoted 7 lines · Bagas Sanjaya
Quoted 1 line · Kloudifold

Subject: [PATCH v2] staging: sm750: Rename functions from CamelCase to snake case

If I only see the subject above, which functions are renamed? I have to see the actual diff if the patch description doesn't answer that. In this case, I think the proper subject would be `[PATCH v3] staging:
sm750: Rename sm750_hw_cursor_* functions to snake_case`.

Quoted 6 lines

No. The oneliner is a brief overview.

It is perfectly appropriate to have to look at the diff to see what was done. The commit message is to state what the problem was and how it was fixed.

OK but I prefer to be more explicit in the subject and the description so that I don't have to guess :)

Signature · 1 line
An old man doll... just what I always wanted! - Clara