Skip to content

Commit 6e4ad58

Browse files
authored
Merge pull request #14889 from github/changedocs/2.15.3
Fix changelog docs based on latest generator version
2 parents 60ebe3b + bff86ed commit 6e4ad58

File tree

6 files changed

+61
-25
lines changed

6 files changed

+61
-25
lines changed

docs/codeql/codeql-overview/codeql-changelog/codeql-cli-2.11.0.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ Java
7171
JavaScript/TypeScript
7272
"""""""""""""""""""""
7373

74-
* Improved how the JavaScript parser handles ambiguities between plain JavaScript and dialects such as Flow and E4X that use the same file extension. The parser now prefers plain JavaScript if possible, falling back to dialects only if the source code can not be parsed as plain JavaScript. Previously, there were rare cases where parsing would fail because the parser would erroneously attempt to parse dialect-specific syntax in a regular JavaScript file.- The :code:`js/regexp/always-matches` query will no longer report an empty regular expression as always matching, as this is often the intended behavior.
75-
74+
* Improved how the JavaScript parser handles ambiguities between plain JavaScript and dialects such as Flow and E4X that use the same file extension. The parser now prefers plain JavaScript if possible, falling back to dialects only if the source code can not be parsed as plain JavaScript. Previously, there were rare cases where parsing would fail because the parser would erroneously attempt to parse dialect-specific syntax in a regular JavaScript file.
75+
* The :code:`js/regexp/always-matches` query will no longer report an empty regular expression as always matching, as this is often the intended behavior.
7676
* The alert message of many queries have been changed to make the message consistent with other languages.
7777

7878
Python

docs/codeql/codeql-overview/codeql-changelog/codeql-cli-2.15.0.rst

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -147,15 +147,11 @@ Ruby
147147
Swift
148148
"""""
149149

150-
* The predicates :code:`getABaseType`, :code:`getABaseTypeDecl`, :code:`getADerivedType` and :code:`getADerivedTypeDecl` on :code:`Type` and :code:`TypeDecl` now behave more usefully and consistently. They now explore through type aliases used in base class declarations, and include protocols added in extensions.To examine base class declarations at a low level without these enhancements, use :code:`TypeDecl.getInheritedType`.
151-
* Modelled varargs function in :code:`NSString` more accurately.
152-
* Modelled :code:`CustomStringConvertible.description` and :code:`CustomDebugStringConvertible.debugDescription`, replacing ad-hoc models of these properties on derived classes.
153-
* The regular expressions library now accepts a wider range of mode flags in a regular expression mode flag group (such as :code:`(?u)`). The :code:`(?w`) flag has been renamed from "UNICODE" to "UNICODEBOUNDARY", and the :code:`(?u)` flag is called "UNICODE" in the libraries.
154-
* Renamed :code:`TypeDecl.getBaseType/1` to :code:`getInheritedType`.
155-
* Flow through writes via keypaths is now supported by the data flow library.
156-
* Added flow through variadic arguments, and the :code:`getVaList` function.
157-
* Added flow steps through :code:`Dictionary` keys and values.
158-
* Added taint models for :code:`Numeric` conversions.
150+
* The predicates :code:`getABaseType`, :code:`getABaseTypeDecl`, :code:`getADerivedType` and :code:`getADerivedTypeDecl` on :code:`Type` and :code:`TypeDecl` now behave more usefully and consistently. They now explore through type aliases used in base class declarations, and include protocols added in extensions.
151+
152+
To examine base class declarations at a low level without these enhancements, use :code:`TypeDecl.getInheritedType`.
153+
154+
:code:`Type.getABaseType` (only) previously resolved a type alias it was called directly on. This behaviour no longer exists. To find any base type of a type that could be an alias, the construct :code:`Type.getUnderlyingType().getABaseType*()` is recommended.
159155

160156
Minor Analysis Improvements
161157
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -188,6 +184,18 @@ Python
188184
* Django Rest Framework better handles custom :code:`ModelViewSet` classes functions
189185
* Regular expression fragments residing inside implicitly concatenated strings now have better location information.
190186

187+
Swift
188+
"""""
189+
190+
* Modelled varargs function in :code:`NSString` more accurately.
191+
* Modelled :code:`CustomStringConvertible.description` and :code:`CustomDebugStringConvertible.debugDescription`, replacing ad-hoc models of these properties on derived classes.
192+
* The regular expressions library now accepts a wider range of mode flags in a regular expression mode flag group (such as :code:`(?u)`). The :code:`(?w`) flag has been renamed from "UNICODE" to "UNICODEBOUNDARY", and the :code:`(?u)` flag is called "UNICODE" in the libraries.
193+
* Renamed :code:`TypeDecl.getBaseType/1` to :code:`getInheritedType`.
194+
* Flow through writes via keypaths is now supported by the data flow library.
195+
* Added flow through variadic arguments, and the :code:`getVaList` function.
196+
* Added flow steps through :code:`Dictionary` keys and values.
197+
* Added taint models for :code:`Numeric` conversions.
198+
191199
Deprecated APIs
192200
~~~~~~~~~~~~~~~
193201

docs/codeql/codeql-overview/codeql-changelog/codeql-cli-2.15.3.rst

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,11 @@ C/C++
138138
C#
139139
""
140140

141-
* The predicate :code:`UnboundGeneric::getName` now prints the number of type parameters as a :code:` `N` suffix, instead of a :code:`<,...,>` suffix. For example, the unbound generic type
142-
:code:`System.Collections.Generic.IList<T>` is printed as :code:`IList`1` instead of :code:`IList<>`.
141+
* The predicate :code:`UnboundGeneric::getName` now prints the number of type parameters as a ```N`` suffix, instead of a :code:`<,...,>` suffix. For example, the unbound generic type
142+
:code:`System.Collections.Generic.IList<T>` is printed as ``IList`1`` instead of :code:`IList<>`.
143+
143144
* The predicates :code:`hasQualifiedName`, :code:`getQualifiedName`, and :code:`getQualifiedNameWithTypes` have been deprecated, and are instead replaced by :code:`hasFullyQualifiedName`, :code:`getFullyQualifiedName`, and :code:`getFullyQualifiedNameWithTypes`, respectively. The new predicates use the same format for unbound generic types as mentioned above.
145+
144146
* These changes also affect models-as-data rows that refer to a field or a property belonging to a generic type. For example, instead of writing
145147

146148
.. code-block:: yaml
@@ -152,6 +154,17 @@ C#
152154
data:
153155
- ["System.Collections.Generic", "Dictionary<TKey,TValue>", False, "Add", "(System.Collections.Generic.KeyValuePair<TKey,TValue>)", "", "Argument[0].Property[System.Collections.Generic.KeyValuePair<,>.Key]", "Argument[this].Element.Property[System.Collections.Generic.KeyValuePair<,>.Key]", "value", "manual"]
154156
157+
one now writes
158+
159+
.. code-block:: yaml
160+
161+
extensions:
162+
- addsTo:
163+
pack: codeql/csharp-all
164+
extensible: summaryModel
165+
data:
166+
- ["System.Collections.Generic", "Dictionary<TKey,TValue>", False, "Add", "(System.Collections.Generic.KeyValuePair<TKey,TValue>)", "", "Argument[0].Property[System.Collections.Generic.KeyValuePair`2.Key]", "Argument[this].Element.Property[System.Collections.Generic.KeyValuePair`2.Key]", "value", "manual"]
167+
155168
* The models-as-data format for types and methods with type parameters has been changed to include the names of the type parameters. For example, instead of writing
156169

157170
.. code-block:: yaml
@@ -164,6 +177,18 @@ C#
164177
- ["System.Collections.Generic", "IList<>", True, "Insert", "(System.Int32,T)", "", "Argument[1]", "Argument[this].Element", "value", "manual"]
165178
- ["System.Linq", "Enumerable", False, "Select<,>", "(System.Collections.Generic.IEnumerable<TSource>,System.Func<TSource,System.Int32,TResult>)", "", "Argument[0].Element", "Argument[1].Parameter[0]", "value", "manual"]
166179
180+
one now writes
181+
182+
.. code-block:: yaml
183+
184+
extensions:
185+
- addsTo:
186+
pack: codeql/csharp-all
187+
extensible: summaryModel
188+
data:
189+
- ["System.Collections.Generic", "IList<T>", True, "Insert", "(System.Int32,T)", "", "Argument[1]", "Argument[this].Element", "value", "manual"]
190+
- ["System.Linq", "Enumerable", False, "Select<TSource,TResult>", "(System.Collections.Generic.IEnumerable<TSource>,System.Func<TSource,System.Int32,TResult>)", "", "Argument[0].Element", "Argument[1].Parameter[0]", "value", "manual"]
191+
167192
Golang
168193
""""""
169194

docs/codeql/codeql-overview/codeql-changelog/codeql-cli-2.7.5.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Java
6868
JavaScript/TypeScript
6969
"""""""""""""""""""""
7070

71-
* Support for handlebars templates has improved. Raw interpolation tags of the form :code:`{{&amp; ... }}` are now recognized,
71+
* Support for handlebars templates has improved. Raw interpolation tags of the form :code:`{{& ... }}` are now recognized,
7272
as well as whitespace-trimming tags like :code:`{{~ ... }}`.
7373
* Data flow is now tracked across middleware functions in more cases, leading to more security results in general. Affected packages are :code:`express` and :code:`fastify`.
7474
* :code:`js/missing-token-validation` has been made more precise, yielding both fewer false positives and more true positives.

docs/codeql/codeql-overview/codeql-changelog/codeql-cli-2.8.0.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -122,18 +122,16 @@ Major Analysis Improvements
122122
C#
123123
""
124124

125-
* Added support for the following C# 10 features.* \ `Record structs <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#record-structs>`__.
125+
* Added support for the following C# 10 features.
126+
* \ `Record structs <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#record-structs>`__.
127+
* \ `Improvements of structure types <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#improvements-of-structure-types>`__.
126128

127-
* \ `Improvements of structure types <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#improvements-of-structure-types>`__.
129+
* Instance parameterless constructor in a structure type.
130+
* Enhance :code:`WithExpr` in QL to support :code:`structs` and anonymous classes.
128131

129-
* Instance parameterless constructor in a structure type.
130-
* Enhance :code:`WithExpr` in QL to support :code:`structs` and anonymous classes.
131-
132-
* \ `Global using directives <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#global-using-directives>`__.
133-
* \ `File-scoped namespace declaration <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#file-scoped-namespace-declaration>`__.
134-
* \ `Enhanced #line pragma <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#enhanced-line-pragma>`__.
135-
136-
* The query :code:`cs/local-shadows-member` no longer highlights parameters of :code:`record` types.
132+
* \ `Global using directives <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#global-using-directives>`__.
133+
* \ `File-scoped namespace declaration <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#file-scoped-namespace-declaration>`__.
134+
* \ `Enhanced #line pragma <https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-10#enhanced-line-pragma>`__.
137135

138136
Minor Analysis Improvements
139137
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -143,6 +141,11 @@ C/C++
143141

144142
* :code:`FormatLiteral::getMaxConvertedLength` now uses range analysis to provide a more accurate length for integers formatted with :code:`%x`
145143

144+
C#
145+
""
146+
147+
* The query :code:`cs/local-shadows-member` no longer highlights parameters of :code:`record` types.
148+
146149
Deprecated APIs
147150
~~~~~~~~~~~~~~~
148151

docs/codeql/codeql-overview/codeql-changelog/codeql-cli-2.9.3.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Ruby
160160
""""
161161

162162
* Support for data flow through instance variables has been added.
163-
* Support of the safe navigation operator (:code:`&amp;.`) has been added; there is a new predicate :code:`MethodCall.isSafeNavigation()`.
163+
* Support of the safe navigation operator (:code:`&.`) has been added; there is a new predicate :code:`MethodCall.isSafeNavigation()`.
164164

165165
Deprecated APIs
166166
~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)