Improve SoATemplate README by Electricks94 · Pull Request #51615 · cms-sw/cmssw

Electricks94 · 2026-08-03T14:29:42Z

PR description:

This PR improves the README of SoATemplate.

PR validation:

This PR is documentation only and does not change any code

fixes #51522

@felicepantaleo fyi

cmsbuild · 2026-08-03T14:30:08Z

cms-bot internal usage

Electricks94 · 2026-08-03T14:30:50Z

@chrishanw does this PR address all problems you had with the README of the SoATemplate?

cmsbuild · 2026-08-03T14:31:50Z

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-51615/50418

There are other open Pull requests which might conflict with changes you have proposed:
- File DataFormats/SoATemplate/README.md modified in PR(s): [Draft] Allow users to set a valid data range for the SoA View #49204, Implement heterogeneous Association Map based on SoA blocks #49995
- File DataFormats/SoATemplate/interface/SoABlocks.h modified in PR(s): Implement heterogeneous Association Map based on SoA blocks #49995
- File DataFormats/SoATemplate/test/SoAStreamInternal_t.cc modified in PR(s): SoA Schema evolution #50691

cmsbuild · 2026-08-03T14:32:12Z

A new Pull Request was created by @Electricks94 for master.

It involves the following packages:

DataFormats/SoATemplate (heterogeneous)

@cmsbuild, @fwyzard, @makortel can you please review it and eventually sign? Thanks.
@missirol, @mmusich, @rovere this is something you requested to watch as well.
@ftenchini, @mandrenguyen, @sextonkennedy you are the release manager for this.

cms-bot commands are listed here

cmsbuild · 2026-08-03T14:41:52Z

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-51615/50420

There are other open Pull requests which might conflict with changes you have proposed:
- File DataFormats/SoATemplate/README.md modified in PR(s): [Draft] Allow users to set a valid data range for the SoA View #49204, Implement heterogeneous Association Map based on SoA blocks #49995
- File DataFormats/SoATemplate/interface/SoABlocks.h modified in PR(s): Implement heterogeneous Association Map based on SoA blocks #49995
- File DataFormats/SoATemplate/test/SoAStreamInternal_t.cc modified in PR(s): SoA Schema evolution #50691

cmsbuild · 2026-08-03T14:42:12Z

Pull request #51615 was updated. @cmsbuild, @fwyzard, @makortel can you please check and sign again.

fwyzard · 2026-08-04T12:35:01Z

 #include <catch2/catch_all.hpp>

-#include "DataFormats/SoATemplate/interface/SoALayout.h"
+#include "DataFormats/SoATemplate/interface/SoABlocks.h"


I think you should include both ?
In general I find it god practice to include all usad headers explicitly, without relying on transitive inclusions.

fwyzard · 2026-08-04T12:38:41Z

    struct ViewTemplateFreeParams;                                                                                     \
                                                                                                                       \
+    SOA_HOST_ONLY                                                                                                      \
+    void soaToStreamInternal(std::ostream & _soa_impl_os) const {                                                      \


Is this tested anywhere ?
More in general, can you add an example of using this to the README ?

fwyzard · 2026-08-04T12:39:56Z

@Electricks94 thanks for the update to the documentation.

Could you split the documentation changes and the code changes in two different commits ?

Could you reflow the README file to stay within 120 columns, where possible ?

Thanks!

cmsbuild · 2026-08-11T12:48:45Z

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-51615/50543

There are other open Pull requests which might conflict with changes you have proposed:
- File DataFormats/SoATemplate/README.md modified in PR(s): [Draft] Allow users to set a valid data range for the SoA View #49204, Implement heterogeneous Association Map based on SoA blocks #49995, Introspection for SoABlocks #51670

cmsbuild · 2026-08-11T12:49:07Z

Pull request #51615 was updated. @cmsbuild, @fwyzard, @makortel can you please check and sign again.

cmsbuild · 2026-08-11T13:09:16Z

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-51615/50544

There are other open Pull requests which might conflict with changes you have proposed:
- File DataFormats/SoATemplate/README.md modified in PR(s): [Draft] Allow users to set a valid data range for the SoA View #49204, Implement heterogeneous Association Map based on SoA blocks #49995, Introspection for SoABlocks #51670

cmsbuild · 2026-08-11T13:09:43Z

Pull request #51615 was updated. @cmsbuild, @fwyzard, @makortel can you please check and sign again.

Electricks94 · 2026-08-11T13:10:55Z

@Electricks94 thanks for the update to the documentation.

Could you split the documentation changes and the code changes in two different commits ?

Could you reflow the README file to stay within 120 columns, where possible ?

Thanks!

Accidently I misread the comment and pushed the code changes to a new PR... I am sorry for that! The code changes are now in #51670 and the changes to the README here.

I formatted the README file to stay within the 120 columns limit always

fwyzard · 2026-08-11T17:02:48Z

No problem... hopefully the two PRs will not conflict.

fwyzard · 2026-08-11T17:02:57Z

+heterogeneous

cmsbuild · 2026-08-11T17:03:07Z

This pull request is fully signed and it will be integrated in one of the next master IBs after it passes the integration tests. This pull request will now be reviewed by the release team before it's merged. @sextonkennedy, @ftenchini, @mandrenguyen (and backports should be raised in the release meeting by the corresponding L2)

fwyzard · 2026-08-11T17:04:17Z

please test

fwyzard · 2026-08-11T17:11:15Z

@smuzaffar @akritkbehera do you think the bot could be developed so if the only changes in a PR are about documentation, the tests can be skipped?

For example if the only changes are in files with an extension of .md ?

cmsbuild · 2026-08-11T18:27:37Z

+1

Size: This PR adds an extra 28KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-8848d9/55254/summary.html
COMMIT: 1142486
CMSSW: CMSSW_20_1_X_2026-08-11-1100/el9_amd64_gcc13
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/51615/55254/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

You potentially added 1 lines to the logs
Reco comparison results: 0 differences found in the comparisons
DQMHistoTests: Total files compared: 44
DQMHistoTests: Total histograms compared: 3433258
DQMHistoTests: Total failures: 22
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 3433218
DQMHistoTests: Total skipped: 18
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 43 files compared)
Checked 191 log files, 159 edm output root files, 44 DQM output files
TriggerResults: no differences found

mandrenguyen · 2026-08-12T05:21:46Z

+1

smuzaffar · 2026-08-12T07:49:59Z

@smuzaffar @akritkbehera do you think the bot could be developed so if the only changes in a PR are about documentation, the tests can be skipped?

For example if the only changes are in files with an extension of .md ?

sure @fwyzard , I will open cms-bot to do that

smuzaffar · 2026-08-12T09:00:17Z

@smuzaffar @akritkbehera do you think the bot could be developed so if the only changes in a PR are about documentation, the tests can be skipped?

For example if the only changes are in files with an extension of .md ?

done via cms-sw/cms-bot#2824

cmsbuild added this to the CMSSW_20_1_X milestone Aug 3, 2026

cmsbuild added pending-signatures tests-pending orp-pending code-checks-pending heterogeneous-pending labels Aug 3, 2026

cmsbuild added code-checks-approved and removed code-checks-pending labels Aug 3, 2026

Electricks94 force-pushed the ReworkSoAREADME branch from 5ffa1e2 to d486ba1 Compare August 3, 2026 14:40

cmsbuild added code-checks-pending and removed code-checks-approved labels Aug 3, 2026

cmsbuild added code-checks-approved and removed code-checks-pending labels Aug 3, 2026

fwyzard reviewed Aug 4, 2026

View reviewed changes

cmsbuild mentioned this pull request Aug 11, 2026

Introspection for SoABlocks #51670

Open

Electricks94 force-pushed the ReworkSoAREADME branch from d486ba1 to 1ad3084 Compare August 11, 2026 12:46

cmsbuild added code-checks-pending and removed code-checks-approved labels Aug 11, 2026

cmsbuild added code-checks-approved and removed code-checks-pending labels Aug 11, 2026

Improve SoATemplate README

1142486

Electricks94 force-pushed the ReworkSoAREADME branch from 1ad3084 to 1142486 Compare August 11, 2026 13:07

cmsbuild added code-checks-pending and removed code-checks-approved labels Aug 11, 2026

cmsbuild added code-checks-approved and removed code-checks-pending labels Aug 11, 2026

cmsbuild added fully-signed heterogeneous-approved and removed pending-signatures heterogeneous-pending labels Aug 11, 2026

cmsbuild added tests-started and removed tests-pending labels Aug 11, 2026

cmsbuild added tests-approved and removed tests-started labels Aug 11, 2026

cmsbuild added orp-approved and removed orp-pending labels Aug 12, 2026

cmsbuild merged commit d6e7eb5 into cms-sw:master Aug 12, 2026
10 checks passed

smuzaffar mentioned this pull request Aug 12, 2026

skip tests for doc files changes cms-sw/cms-bot#2824

Merged

Uh oh!

Conversation

Electricks94 commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR description:

PR validation:

Uh oh!

cmsbuild commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Electricks94 commented Aug 3, 2026

Uh oh!

cmsbuild commented Aug 3, 2026

Uh oh!

cmsbuild commented Aug 3, 2026

Uh oh!

cmsbuild commented Aug 3, 2026

Uh oh!

cmsbuild commented Aug 3, 2026

Uh oh!

fwyzard Aug 4, 2026

Choose a reason for hiding this comment

Uh oh!

fwyzard Aug 4, 2026

Choose a reason for hiding this comment

Uh oh!

fwyzard commented Aug 4, 2026

Uh oh!

cmsbuild commented Aug 11, 2026

Uh oh!

cmsbuild commented Aug 11, 2026

Uh oh!

cmsbuild commented Aug 11, 2026

Uh oh!

cmsbuild commented Aug 11, 2026

Uh oh!

Electricks94 commented Aug 11, 2026

Uh oh!

fwyzard commented Aug 11, 2026

Uh oh!

fwyzard commented Aug 11, 2026

Uh oh!

cmsbuild commented Aug 11, 2026

Uh oh!

fwyzard commented Aug 11, 2026

Uh oh!

fwyzard commented Aug 11, 2026

Uh oh!

cmsbuild commented Aug 11, 2026

Comparison Summary

Uh oh!

mandrenguyen commented Aug 12, 2026

Uh oh!

Uh oh!

smuzaffar commented Aug 12, 2026

Uh oh!

smuzaffar commented Aug 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Electricks94 commented Aug 3, 2026 •

edited

Loading

cmsbuild commented Aug 3, 2026 •

edited

Loading