treewide: Use hyphens instead of underscores for property separation

[rruuaanng]

This inherits from proposal #53502, with the main work as shown in the title. For details, see #53506.

[rruuaanng]

I have a lot of work to catch up on right now, like CI checks and other underlying changes (maybe due to a lack of focus).

[rruuaanng]

I wrote another PR which adds the devicetree coding style to the contributor guide.
(it provides a link to the upstream Linux kernel devicetree coding style.)

#83379

[rruuaanng]

I agree, I will separate the huge DTS commit into another PR later, it makes my force push very slow.

[rruuaanng]

@cfriedt The advancement of this proposal requires that all sub-PRs be merged and this PR be processed last. Because CI will throw a warning, we need to leave it to the end to solve it. They appear to have dozens of commits that modify the bindings and DTS between different subsystems.

[rruuaanng]

I believe I need to open this issue to the community, as it is a large-scale task. Given my current workload, I’m unable to dedicate my full attention to it. I will focus solely on handling this PR.

[cfriedt]

@cfriedt The advancement of this proposal requires that all sub-PRs be merged and this PR be processed last. Because CI will throw a warning, we need to leave it to the end to solve it. They appear to have dozens of commits that modify the bindings and DTS between different subsystems.

Call me skeptical (hopeful?), but I think that there is probably a way to a) activate CI checks only when a DT binding has changed, and b) find one binding to change that does not require changing the entire tree all at once.

[mbolivar]

The final step is to add an @mbolivar sign-off to the commit, specifically for the edtlib and CI checker sections. For these, I have referred to his implementation, and this needs to be accompanied by his personal authorization.

@rruuaanng thanks again for taking this on. Just to clarify, you don't need my personal authorization to add my signed-off-by: to any commits that you create, as long as I already added the signed-off-by: myself and opened a pull request with that commit to upstream zephyr.

When I added my signed-off-by: and created a PR, I was certifying for legal purposes (see the DCO docs) that I was able to submit the code under the appropriate license (apache 2 or other file-specific license) to the project at the time I opened the PR.

You are free to use the code under that license however you want, as long as you comply with the license's terms. You don't need any additional permission from me. The only thing you have to do is make sure that my signed-off-by: lines stay on any commits you submit yourself if they are adapted from my work.

[rruuaanng]

@cfriedt The advancement of this proposal requires that all sub-PRs be merged and this PR be processed last. Because CI will throw a warning, we need to leave it to the end to solve it. They appear to have dozens of commits that modify the bindings and DTS between different subsystems.

Call me skeptical (hopeful?), but I think that there is probably a way to a) activate CI checks only when a DT binding has changed, and b) find one binding to change that does not require changing the entire tree all at once.

Oh, I almost forgot. Currently, the binding style checks are skipped when no changes are made to the bindings. Let's wait and see.

        # If no bindings are changed, skip this check.
        try:
            subprocess.check_call(['git', 'diff', '--quiet', COMMIT_RANGE]
                                  + bindings_diff)
            nodiff = True
        except subprocess.CalledProcessError:
            nodiff = False
        if nodiff:
            self.skip('no changes to bindings were made')

Edit

If this operation needs to be implemented, I will need to remove the edtlib check during the build, otherwise, it won't pass the build and will cause the CI to fail.

    def _check_with_underscores(self, prop_name):
        # Allow special case property names
        # The content of this set needs to be consistent with the
        # content of 'scripts/ci/bindings_propertys_name_wl.yaml'
        wl = {'mmc-hs200-1_8v', 'mmc-hs400-1_8v'}

        if '_' in prop_name and prop_name not in wl:
            _err(f"'{prop_name}' should use hyphens instead of "
                 "underscores in the property name. "
                 f"The property names at '{self.edt.dts_path}' "
                 f"and '{self.binding_path}' must also be updated.")

That is, I did not need to make any changes to edtlib.

[rruuaanng]

The final step is to add an @mbolivar sign-off to the commit, specifically for the edtlib and CI checker sections. For these, I have referred to his implementation, and this needs to be accompanied by his personal authorization.

@rruuaanng thanks again for taking this on. Just to clarify, you don't need my personal authorization to add my signed-off-by: to any commits that you create, as long as I already added the signed-off-by: myself and opened a pull request with that commit to upstream zephyr.

When I added my signed-off-by: and created a PR, I was certifying for legal purposes (see the DCO docs) that I was able to submit the code under the appropriate license (apache 2 or other file-specific license) to the project at the time I opened the PR.

You are free to use the code under that license however you want, as long as you comply with the license's terms. You don't need any additional permission from me. The only thing you have to do is make sure that my signed-off-by: lines stay on any commits you submit yourself if they are adapted from my work.

I hope I haven't misunderstood. This is my current commit message:

    dts: bindings: Change the property names in the bindings

    Change the property names in the bindings and DTS to use
    hyphens(-) for separation instead of underscores(_).

    Signed-off-by: James Roy <[email protected]>
    Signed-off-by: Martí Bolívar <[email protected]>

This commit is based on your work, so I should change it to the following:

    dts: bindings: Change the property names in the bindings

    Change the property names in the bindings and DTS to use
    hyphens(-) for separation instead of underscores(_).

    Signed-off-by: Martí Bolívar <[email protected]>

But for content I have written myself, I only need to use my own signature:

    scripts: Add binding migration script

    This script replaces all underscore(_)
    separation in a binding with hyphens(-).

    Signed-off-by: James Roy <[email protected]>

[rruuaanng]

CI throw

 561f94309a80cfa060b1f38e896f273adb4ade2c: author email (James Roy <[email protected]>) needs to match one of the signed-off-by entries.
Compliance error, check for error messages in the "Run Compliance Tests" step

Okay, it looks like only the signature issue remains. It seems like there might be a misunderstanding on my part? I might need to keep the original commit message.

from https://docs.zephyrproject.org/latest/contribute/guidelines.html#developer-certification-of-origin-dco

If you are altering an existing commit created by someone else, you must add your Signed-off-by: line without removing the existing one.

Hmmm.... It seems that the development process description isn't very clear on this. I apologize for not understanding it even after reading it multiple times. Does "keep" mean adding two signatures? Like this:

    dts: bindings: Change the property names in the bindings

    Change the property names in the bindings and DTS to use
    hyphens(-) for separation instead of underscores(_).

    Signed-off-by: James Roy <[email protected]>
    Signed-off-by: Martí Bolívar <[email protected]>

[cfriedt]

It's definitely saying something about the bottom commit

[cfriedt]

@rruuaanng - you should be able to do git rebase -i HEAD~3, enter r instead of pick for that commit, and then update the commit message to add your signed-off-by line.

[rruuaanng]

@rruuaanng - you should be able to do git rebase -i HEAD~3, enter r instead of pick for that commit, and then update the commit message to add your signed-off-by line.

Should I add two signatures? Like this

    Signed-off-by: James Roy <[email protected]>
    Signed-off-by: Martí Bolívar <[email protected]>

[kartben]

@rruuaanng - you should be able to do git rebase -i HEAD~3, enter r instead of pick for that commit, and then update the commit message to add your signed-off-by line.

Should I add two signatures? Like this

    Signed-off-by: James Roy <[email protected]>
    Signed-off-by: Martí Bolívar <[email protected]>

Yes

[rruuaanng]

Sure, everything looks good with the CI, and we can make a decision on the proposal.

[cfriedt]

Probably can work around this using ruff - @pdgendt is fairly familiar with that.

[cfriedt]

I'm surprised that so much needs to be added in this file

[cfriedt]

Probably want this to be a list of Path objects

[rruuaanng]

Strings list are convenient for command lines to pass parameters, see line 84

the commits changing the tree dont seem to exist anymore

[mbolivar]

This is my current commit message:

This is correct -- for commits based on mine that you altered or incorporated here, use both my and your signed-off-by-lines.

But for work that is yours alone, use just your signed-off-by.

[rruuaanng]

@decsny They are scattered into a task list, and you can give some help when you have time :)
#83741