Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docfx/Docfx.App.dll
Binary file not shown.
Binary file modified docfx/Docfx.App.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Build.Common.dll
Binary file not shown.
Binary file modified docfx/Docfx.Build.Common.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Build.ManagedReference.dll
Binary file not shown.
Binary file modified docfx/Docfx.Build.ManagedReference.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Build.OverwriteDocuments.dll
Binary file not shown.
Binary file modified docfx/Docfx.Build.OverwriteDocuments.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Build.RestApi.dll
Binary file not shown.
Binary file modified docfx/Docfx.Build.RestApi.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Build.SchemaDriven.dll
Binary file not shown.
Binary file modified docfx/Docfx.Build.SchemaDriven.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Build.UniversalReference.dll
Binary file not shown.
Binary file modified docfx/Docfx.Build.UniversalReference.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Build.dll
Binary file not shown.
Binary file modified docfx/Docfx.Build.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Common.dll
Binary file not shown.
Binary file modified docfx/Docfx.Common.pdb
Binary file not shown.
Binary file modified docfx/Docfx.DataContracts.Common.dll
Binary file not shown.
Binary file modified docfx/Docfx.DataContracts.Common.pdb
Binary file not shown.
Binary file modified docfx/Docfx.DataContracts.RestApi.dll
Binary file not shown.
Binary file modified docfx/Docfx.DataContracts.RestApi.pdb
Binary file not shown.
Binary file modified docfx/Docfx.DataContracts.UniversalReference.dll
Binary file not shown.
Binary file modified docfx/Docfx.DataContracts.UniversalReference.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Dotnet.dll
Binary file not shown.
Binary file modified docfx/Docfx.Dotnet.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Glob.dll
Binary file not shown.
Binary file modified docfx/Docfx.Glob.pdb
Binary file not shown.
Binary file modified docfx/Docfx.MarkdigEngine.Extensions.dll
Binary file not shown.
Binary file modified docfx/Docfx.MarkdigEngine.Extensions.pdb
Binary file not shown.
Binary file modified docfx/Docfx.MarkdigEngine.dll
Binary file not shown.
Binary file modified docfx/Docfx.MarkdigEngine.pdb
Binary file not shown.
Binary file modified docfx/Docfx.Plugins.dll
Binary file not shown.
Binary file modified docfx/Docfx.Plugins.pdb
Binary file not shown.
Binary file modified docfx/Docfx.YamlSerialization.dll
Binary file not shown.
Binary file modified docfx/Docfx.YamlSerialization.pdb
Binary file not shown.
12 changes: 10 additions & 2 deletions docfx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ The assembly is a component of the identity, not a namespace segment: `LinqToDB`
in titles, breadcrumbs and links, and only the UID and the file name carry the assembly (`::` becomes `--`
in file names, as `:` is not legal there).

Nothing displayed names the assembly, because `assemblyLabel` is left at its default of `none`. The
previous vendored build appended it to every namespace, so the table of contents read
`LinqToDB (linq2db.Tools)` and so did the page titles, on the 34 namespaces only one assembly declares as
well as the 6 more than one does. Setting `assemblyLabel` to `shared` would not change this site either:
it compares the namespaces of a single `metadata` entry, and every entry here documents one assembly, so
the collisions it would label are all across entries where they cannot be seen. `suffix` on the colliding
entries is the option if the assembly should ever be named.

This replaces the older `globalPrefix` hack, which produced a malformed `commentId`, unprefixed
namespace and type hrefs, and ~1200 dead in-page anchors, and the `assemblyUidPrefixes` /
`uidPrefixOverride` pair before it, which spelled the assembly as a leading namespace segment and so
Expand All @@ -33,7 +41,7 @@ surfaced in page titles and the table of contents as a namespace that does not e
## How this build is produced

Branch: [`fix/8966-uid-prefixes`](https://github.com/MaceWindu/docfx/pull/2) in
<https://github.com/MaceWindu/docfx>, currently `9907932d6` — the branch proposed for upstream, with
<https://github.com/MaceWindu/docfx>, currently `beda63b23` — the branch proposed for upstream, with
nothing added on top.

The previous build needed one extra commit bumping Roslyn to 5.6.0, because with Roslyn 5.0.0 and the
Expand All @@ -55,7 +63,7 @@ dotnet build src/docfx/docfx.csproj -c Release -f net10.0
`docfx.exe --version` prints the source commit, so the vendored build can always be traced back:

```
1.0.0+9907932d6be6ad503885fc5c3c166ae4ce952be9
1.0.0+beda63b230d24f8a4b9a0e09fc4e690e36510fd2
```

## When can this go away
Expand Down
Binary file modified docfx/docfx.dll
Binary file not shown.
Binary file modified docfx/docfx.exe
Binary file not shown.
Binary file modified docfx/docfx.pdb
Binary file not shown.
5 changes: 3 additions & 2 deletions source/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
// here, not only the ones whose namespaces collide.
//
// The assembly is not part of the namespace, so pages, titles and links keep naming the namespaces as
// they are declared. `LinqToDB` reads as `LinqToDB` everywhere, and the assembly is what the table of
// contents groups by.
// they are declared: `LinqToDB` reads as `LinqToDB` everywhere, and only the UID and the file name
// carry the assembly. `assemblyLabel` is left unset, which is what keeps it that way; setting it to
// `suffix` would append the assembly to every namespace label and page title.
//
// LinqToDB.Identity is deliberately absent: its namespace does not collide and nothing else here
// references it.
Expand Down