llvm / llvm/llvm-project

[libc++] Document implementation-defined behaviour of filebuf::sync()

Open
#180,506 0 comments 1 reaction 0 assignees View on GitHub
documentation libc++
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

https://eel.is/c++draft/filebuf#virtuals-19 states that a flebuf with a get area causes implementation-defined behaviour. We should document that behaviour.

Contributor guide

Open the contributing guide

Research direction

Start by locating libc++'s filebuf::sync() implementation and compare its get-area behavior with the C++ draft section at eel.is/c++draft/filebuf#virtuals-19. Identify the implementation-defined behavior that should be documented, then update the relevant libc++ documentation and verify that it accurately describes the implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.