KhronosGroup / KhronosGroup/OpenCL-Docs

Turn Copyright Header Update Command into Script

Open
#788 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
421
Forks
132
Avg merge
5d 13h
Merged PRs (30d)
11

Description

The description of PR https://github.com/KhronosGroup/OpenCL-Docs/pull/757 has a single command for updating copyright headers, that should be copy pasted into a script for when 2023+ comes around.

Given the command modifies spec source some safety checks may be prudent, e.g. don't run on a "dirty" direction, and that running the script twice doesn't do anything odd.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the copyright-header command described in PR 757 and inspect how the OpenCL spec source is organized. Create a script around that command with checks for a dirty working directory and safe repeated runs; done means the script updates headers without unintended source changes when run twice.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.