KhronosGroup / KhronosGroup/OpenCL-Docs

Unified API Spec: Consider a Removed State

Open
#153 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

During review of the initial draft of a unified API specification there was a question [1] about have a removed by state. OpenCL has not been explicit about removing things previously, though pragmatically I expect some aspects will not be present in any modern implementation.

This ticket is to first gather together a plausible list of "removed" features (i.e. features that were deprecated and are no longer present in modern implementations), and second to propose a way of representing this in the specification.

[1] https://github.com/KhronosGroup/OpenCL-Docs/pull/78#discussion_r334985389

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 initial draft of the unified API specification and the discussion in pull request 78 linked from this issue. Compile a plausible list of deprecated features absent from modern implementations, then document a proposed way to represent a removed state; done means both the list and representation proposal are recorded for review.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.