Skip to content

Commit 2952db1

Browse files
authored
Address warnings from building spec (#1523)
* Suppress warnings about unreferenced definitions * Address RFC2119 keyword warnings * Address example-ID warnings * Fail spec builds on lint issues To help catch unused definitions.
1 parent 82db68e commit 2952db1

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $(bikeshed): $(venv-marker) Makefile
1818
@touch $@
1919

2020
$(OUT_DIR)/index.html: index.bs $(OUT_DIR) $(bikeshed)
21-
$(bikeshed) --die-on=warning spec $< $@
21+
$(bikeshed) --die-on=lint spec $< $@
2222

2323
validator: $(OUT_DIR)/validate-headers.html $(OUT_DIR)/validate-headers.js $(OUT_DIR)/filters.html $(OUT_DIR)/filters-main.js
2424

index.bs

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ a [=set=] of [=strings=] |allowedKeys|:
431431
value |value|, and the parameters |params| to |entries|.
432432
1. Return a [=structured header/dictionary=] containing |entries|.
433433

434-

The user agent may "[=structured header/define new structured fields|grease=]" the

434+

The user agent can "[=structured header/define new structured fields|grease=]" the

435435
dictionary structured headers according to the preceding algorithm to help ensure that recipients
436436
use a proper structured header parser, rather than naive string equality or
437437
`contains` operations, which makes it easier to introduce backwards-compatible
@@ -443,14 +443,14 @@ members helps ensure that, e.g., "`key1, key2`" is treated equivalently to "`key
443443
In the following example, only the "`trigger`" key should be interpreted by the
444444
recipient after the header has been parsed as a structured dictionary:
445445

446-
446+
 id=grease-eligible>
447447
Attribution-Reporting-Eligible: not-event-source, trigger=event-source;navigation-source=3
448448
449449

450450
In the following example, only the "`os`" key should be interpreted by the
451451
recipient after the header has been parsed as a structured dictionary:
452452

453-
453+
 id=grease-support>
454454
Attribution-Reporting-Support: os=web
455455
456456

@@ -1173,7 +1173,7 @@ Possible values are:
11731173
  • "source-storage-limit"
  • 11741174
  • "source-success"
  • 11751175
  • "source-trigger-state-cardinality-limit"
  • 1176-
  • "source-unknown-error"
  • 1176+
  • " noexport>source-unknown-error"
  • 11771177
    11781178

    11791179
    A trigger debug data type is a [=debug data type=] for trigger registrations.
    @@ -1201,7 +1201,7 @@ Possible values are:
    12011201
  • "trigger-no-matching-filter-data"
  • 12021202
  • "trigger-no-matching-source"
  • 12031203
  • "trigger-reporting-origin-limit"
  • 1204-
  • "trigger-unknown-error"
  • 1204+
  • " noexport>trigger-unknown-error"
  • 12051205
    12061206

    12071207
    An OS debug data type is a [=debug data type=] for OS registrations.
    @@ -1212,7 +1212,7 @@ Possible values are:
    12121212
  • "os-trigger-delegated"
  • 12131213
    12141214

    1215-
    A header errors debug data type is a [=debug data type=] for
    1215+
    A noexport>header errors debug data type is a [=debug data type=] for
    12161216
    registration header errors. Possible values are:
    12171217

    12181218
      @@ -1587,7 +1587,7 @@ To serialize [=event-level report/attribution destinations=] |destina
      15871587
      1. If |destinationStrings|'s [=set/size=] is equal to 1, return |destinationStrings|[0].
      15881588
      1. Return |destinationStrings|.
      15891589

      1590-

      |destinations| is required to be sorted to avoid revealing extra

      1590+

      |destinations| has to be sorted to avoid revealing extra

      15911591
      information about the original source registration, namely the order of the
      15921592
      "[=source-registration JSON key/destination=]" field in the
      15931593
      original JSON registration, which can be used to distinguish semantically
      @@ -1695,7 +1695,7 @@ To parse an aggregation coordinator given |value|:
      16951695

      16961696

      Parsing aggregatable debug reporting config

      16971697

      1698-
      An aggregatable-debug-reporting JSON key is one of the following:
      1698+
      An noexport>aggregatable-debug-reporting JSON key is one of the following:
      16991699

      17001700
        17011701
      • "aggregation_coordinator_origin"
      • @@ -1789,7 +1789,7 @@ and an [=aggregatable debug reporting config=] |default|:
        17891789
        1. Return |aggregatableDebugReportingConfig|.
        17901790

        17911791

        The parsing errors are intentionally ignored in this algorithm with |default|

        1792-
        returned to avoid data loss from the optional debug reporting feature.
        1792+
        returned to avoid data loss from the debug reporting feature.
        17931793

        17941794

        Getting registration info

        17951795

        @@ -2124,9 +2124,9 @@ and a [=response=] |response|:
        21242124

        21252125
        1. The user-agent may ignore the response; if so, return.
        21262126

        2127-

        The user-agent may prevent attribution for a number of reasons, such as user opt-out. In these

        2127+

        The user-agent can prevent attribution for a number of reasons, such as user opt-out. In these

        21282128
        cases, it is preferred to abort the API flow at response time rather than at request time so this
        2129-
        state is not immediately detectable. Attribution may also be blocked if the reporting origin is not
        2129+
        state is not immediately detectable. Attribution can also be blocked if the reporting origin is not
        21302130
        21312131

        21322132
        1. [=Queue a task=] on the [=networking task source=] to proceed with the following steps.
        @@ -2373,7 +2373,7 @@ To compute the scopes channel capacity of a source given a positive i
        23732373

        23742374

        Parsing source-registration JSON

        23752375

        2376-
        A source-registration JSON key is one of the following:
        2376+
        A noexport>source-registration JSON key is one of the following:
        23772377

        23782378
          23792379
        • "aggregatable_debug_reporting"
        • @@ -2857,11 +2857,11 @@ To delete sources for unexpired destination limit given a [=set=] of
          28572857
          1. [=set/Append=] |report|'s [=event-level report/internal ID=] to |deletedEventLevelReports|.
          28582858
          1. [=set/Remove=] |report| from the [=event-level report cache=].
          28592859

          2860-

          Leaking browsing history of destinations deactivated for unexpired

          2860+

          Leaking browsing history of destinations deactivated for the unexpired

          28612861
          destination limit from [=event-level reports=] whose [=event-level report/trigger time=]
          28622862
          is earlier than |now| is mitigated by the presence of [=obtain a fake report|fake reports=].
          28632863
          [=Event-level reports=] whose [=event-level report/trigger time=] is greater
          2864-
          than or equal to |now| must be deleted to avoid exposing whether an
          2864+
          than or equal to |now| have to be deleted to avoid exposing whether an
          28652865
          [=attribution source=] has a [=attribution source/randomized response=].
          28662866

          28672867
          1. Let |deletedAggregatableReports| be a new [=set=].
          @@ -3041,7 +3041,7 @@ a [=boolean=] |isNoised|, and a [=boolean=] |destinationLimitReplaced|:
          30413041
          1. If |destinationLimitReplaced| is true, [=map/set=] |body|["`source_destination_limit`"]
          30423042
          to the user agent's [=max destinations covered by unexpired sources=], [=serialize an integer|serialized=].
          30433043

          3044-

          The "`source_destination_limit`" field may be included to indicate that

          3044+

          The "`source_destination_limit`" field can be included to indicate that

          30453045
          [=max destinations covered by unexpired sources=] was hit, which is not
          30463046
          reported as "[=source debug data type/source-destination-limit=]" to prevent side-channel
          30473047
          leakage of cross-origin data.
          @@ -3311,16 +3311,16 @@ To process an attribution source given an [=attribution source=] |sou
          33113311
          privacy budget of all possible destinations.
          33123312

          33133313

          The limits that are not reported as [=source debug data type/source-success=]

          3314-
          in [=verbose debug reports=] should be checked before any limits that are reported implicitly as
          3314+
          in [=verbose debug reports=] have to be checked before any limits that are reported implicitly as
          33153315
          [=source debug data type/source-success=] (
          33163316
          [=source debug data type/source-destination-global-rate-limit=] and
          33173317
          [=source debug data type/source-reporting-origin-limit=]) to
          33183318
          prevent side-channel leakage of cross-origin data. Furthermore, the [=verbose debug data=]
          3319-
          should be fully determined regardless of the result of checks on implicitly reported limits.
          3319+
          have to be fully determined regardless of the result of checks on implicitly reported limits.
          33203320

          33213321
          # Triggering Algorithms # {#trigger-algorithms}
          33223322

          3323-
          A trigger-registration JSON key is one of the following:
          3323+
          A noexport>trigger-registration JSON key is one of the following:
          33243324

          33253325
            33263326
          • "aggregatable_debug_reporting"
          • @@ -3688,16 +3688,16 @@ To match [=filter values=] with negation given a [=filter value=] |a|
            36883688

            36893689
            To match an attribution source against a filter config given an
            36903690
            [=attribution source=] |source|, a [=filter config=] |filter|, a [=moment=] |moment|, and a [=boolean=]
            3691-
            isNegated:
            3691+
            |isNegated|:
            36923692

            36933693
            1. Let |lookbackWindow| be |filter|'s [=filter config/lookback window=].
            36943694
            1. If |lookbackWindow| is not null:
            36953695
            1. If the [=duration from=] |moment| and the |source|'s [=attribution source/source time=] is greater than |lookbackWindow|:
            36963696
            1. If |isNegated| is false, return false.
            36973697
            1. Else if |isNegated| is true, return false.
            36983698

            3699-

            If non-negated, the source must have been registered inside of the

            3700-
            lookback window. If negated, it must be outside of the lookback window.
            3699+

            If non-negated, the source had to be registered inside of the

            3700+
            lookback window. If negated, it had to be outside of the lookback window.
            37013701

            37023702
            1. Let |filterMap| be |filter|'s [=filter config/map=].
            37033703
            1. Let |sourceData| be |source|'s [=attribution source/filter data=].
            @@ -3926,7 +3926,7 @@ an [=event-level report=] |b| if any of the following are true:
            39263926
            * |a|'s [=event-level report/trigger priority=] is equal to |b|'s [=event-level report/trigger priority=]
            39273927
            and |a|'s [=event-level report/trigger time=] is greater than |b|'s [=event-level report/trigger time=].
            39283928

            3929-
            An event-level-report-replacement result is one of the following:
            3929+
            An noexport>event-level-report-replacement result is one of the following:
            39303930

            39313931
            39323932
            : "add-new-report"
            @@ -4541,7 +4541,7 @@ To queue reports for delivery given a [=set=] of
            45414541
            1. [=set/Remove=] |report| from |cache|.
            45424542

            45434543

            In order to support sending, waiting, and retries across various

            4544-
            forms of interruption, including shutdown, the user agent may need to
            4544+
            forms of interruption, including shutdown, the user agent might need to
            45454545
            persist reports that are in the process of being sent in some other
            45464546
            storage.
            45474547
            1. [=list/Append=] |report| to |reportsToSend|.
            @@ -4646,7 +4646,7 @@ Issue: Specify this in terms of [=fetch=].
            46464646

            46474647

            The user agent might enforce weekly key rotation. If there are multiple keys, the user agent

            46484648
            might independently pick a key uniformly at random for every encryption operation.
            4649-
            The key should be uniquely identifiable.
            4649+
            The key has to be uniquely identifiable.
            46504650

            46514651
            An [=aggregatable report=] |report|'s plaintext payload
            46524652
            is the result of running the following steps:
            @@ -5063,7 +5063,7 @@ configuration.
            50635063
            50645064
            50655065
            POST
            5066-
            `/session/{session id}/ara/``localtestingmode`
            5066+
            `/session/{session id}/ara/` noexport>`localtestingmode`
            50675067
            50685068
            50695069
            @@ -5099,7 +5099,7 @@ The [=remote end steps=] are:
            50995099
            51005100
            51015101
            POST
            5102-
            `/session/{session id}/ara/``sendpendingreports`
            5102+
            `/session/{session id}/ara/` noexport>`sendpendingreports`
            51035103
            51045104
            51055105

            0 commit comments

            Comments
             (0)