dotnet / dotnet/dotnet-api-docs

System.IO.Ports.SerialPort.PortName should start with "/dev/" on Linux

Aperta
#4,348 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
area-System.IO.Ports Pri3 untriaged
Lingua principale
C#
Stelle
949
Fork
1.7k
Merge medio
2g 19h
PR unite (30g)
52

Descrizione

In , a user constructed ` System.IO.Ports.SerialPort` with "ttyACM0" as `PortName` on Linux and then wondered why it did not work. It would be useful to document that the port name on Linux should be an absolute path such as "/dev/ttyACM0", rather than only the basename "ttyACM0". This would go on the following pages:

- [SerialPort Constructors](https://docs.microsoft.com/dotnet/api/system.io.ports.serialport.-ctor?view=dotnet-plat-ext-3.1), in the description of the `portName` parameter of each constructor that has one
- [SerialPort.PortName Property](https://docs.microsoft.com/en-us/dotnet/api/system.io.ports.serialport.portname?view=dotnet-plat-ext-3.1)

The implementation of the SerialPort.GetPortNames() method appears to return names in the correct format already.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Esamina le pagine collegate SerialPort Constructors e SerialPort.PortName Property, concentrandoti sulle descrizioni del parametro portName. Conferma il comportamento esistente di GetPortNames(), quindi documenta che i nomi delle porte Linux devono essere percorsi assoluti come /dev/ttyACM0; al termine, le pagine indicate dovranno contenere queste indicazioni.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.