Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS: add more details and requirements about incompatible changes #14156

Merged
merged 7 commits into from
May 20, 2024

Commits on May 16, 2024

  1. Configuration menu
    Copy the full SHA
    e8b786b View commit details
    Browse the repository at this point in the history
  2. DOCS/compatibility.rst: require more details about breaking changes

    Currently incompatible changes are not clearly outlined in the related
    documentations, such as interface-changes.rst. The impacts and suggested
    actions to address the compatibility concerns also rarely exist.
    
    This adds a requirement to include these information for incompatible
    changes, so that such changes are clearly conveyed to the users, with
    suggested actions to minimize the impacts of such changes.
    na-na-hi committed May 16, 2024
    Configuration menu
    Copy the full SHA
    065a4fb View commit details
    Browse the repository at this point in the history

Commits on May 17, 2024

  1. DOCS/compatibility.rst: add provision for dealing with severe breakages

    Currently there is no policy on what should be done when an immediate,
    severe breakage happens for "important/often used parts", which can cause
    serious concerns especially if such changes remain obscured.
    
    This adds a provision for this kind of incompatible changes under
    "extraordinary circumstances", which allows for the breaking change to happen
    if there is a critical reason to do so. Such changes must be extensively
    documented, and should be avoided as much as possible.
    na-na-hi committed May 17, 2024
    Configuration menu
    Copy the full SHA
    a604d64 View commit details
    Browse the repository at this point in the history
  2. DOCS/compatibility.rst: add requirement when changing default values

    Documented default values are relied upon by scripts, so changing these
    values can casuse incompatible changes. This makes documenting them
    required.
    na-na-hi committed May 17, 2024
    Configuration menu
    Copy the full SHA
    9976718 View commit details
    Browse the repository at this point in the history
  3. DOCS/man: note that default autoprobe order is unrealiable

    The default values for --ao, --vo, --gpu-api, --gpu-context change from
    time to time, but some libmpv clients rely on the existing autoprobe order
    and breaks as a result when the value changes. This specifies that the
    default autoprobe order should not be relied upon.
    na-na-hi committed May 17, 2024
    Configuration menu
    Copy the full SHA
    b055ef9 View commit details
    Browse the repository at this point in the history
  4. DOCS/man/input.rst: document breaking change of loadfile index argument

    As an instance of "extraordinary circumstances", such incompatibility
    must be extensively documented.
    na-na-hi committed May 17, 2024
    Configuration menu
    Copy the full SHA
    f36efc1 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    f2a932f View commit details
    Browse the repository at this point in the history