Skip to content

STL: We should better tag those files which might end up in import libs #483

@BillyONeal

Description

@BillyONeal

In the review #457 @StephanTLavavej asked for the "ominous comment"

STL/stl/inc/xfacet

Lines 19 to 22 in b350426

// This must be as small as possible, because its contents are
// injected into the msvcprt.lib and msvcprtd.lib import libraries.
// Do not include or define anything else here.
// In particular, basic_string must not be included here.

to be added to a "core" header on the basis that it was included in an import lib. However, that would be incongruous with other core headers, which we already include in our import libs.

We should remove the "ominous comment" from headers and put it in that wiki page, add a link from each "core" header to the wiki page, and ensure the wiki page explains the same content as the "ominous comment". We should also ensure that each .cpp file in the import lib has an ominous comment.

We should probably also update the ominous comment to not talk about the length of included stuff, similar to the following:

// This file is part of the msvcprt.lib and msvcprtd.lib import libraries.
// Therefore, it must not depend on any settings that affect layout or behavior of standard
// library types like _CONTAINER_DEBUG_LEVEL or _ITERATOR_DEBUG_LEVEL.
// In particular, basic_string must not be included here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationRelated to documentation or commentsfixedSomething works now, yay!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions