.netrc behaviour is not documented

Open
#2,159 2 comments 4 reactions 1 assignee View on GitHub

@AedanM is already working on this.

Since Aug 4, 2026.

Assessment

This issue has not been assessed yet.

Description

documentation

The Source subclass DownloadableFileSource reads login credentials from ~/.netrc. This class is used by the included 'tar' source as well as third-party plugins, since it's part of the public API. However, this behaviour is not documented anywhere.

It would be great to have user-facing documentation for this, ideally in its own page such that supporting plugins can link to it.

Dominant language
Python
Stars
144
Forks
45
Avg merge
20h 38m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/buildstream

All issues in apache/buildstream

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.