Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Polish doc after conversion #8530

Merged
merged 2 commits into from
Jun 19, 2024
Merged

Polish doc after conversion #8530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e6c529
polish
IngelaAndin May 29, 2024
6bd3189
Remove link from notes refering to legcy function no longer existing
IngelaAndin May 31, 2024
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
12 changes: 1 addition & 11 deletions lib/ftp/doc/guides/ftp_client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,8 @@ limitations under the License.

%CopyrightEnd%
-->
# FTP Client
# Examples

## Getting Started

FTP clients are considered to be rather temporary. Thus, they are only started
and stopped during runtime and cannot be started at application startup. The FTP
client API is designed to allow some functions to return intermediate results.
This implies that only the process that started the FTP client can access it
with preserved sane semantics. If the process that started the FTP session dies,
the FTP client process terminates.

The client supports IPv6 as long as the underlying mechanisms also do so.

The following is a simple example of an FTP session, where the user `guest` with
password `password` logs on to the remote host `erlang.org`:
Expand Down
16 changes: 8 additions & 8 deletions lib/ftp/doc/guides/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ limitations under the License.

%CopyrightEnd%
-->
# Introduction
# FTP client introduction

## Purpose
FTP clients are considered to be rather temporary. Thus, they are only started
and stopped during runtime and cannot be started at application startup. The FTP
client API is designed to allow some functions to return intermediate results.
This implies that only the process that started the FTP client can access it
with preserved sane semantics. If the process that started the FTP session dies,
the FTP client process terminates.

An `FTP` client.

## Prerequisites

It is assumed that the reader is familiar with the Erlang programming language,
concepts of OTP, and has a basic understanding of the FTP protocol.
The client supports IPv6 as long as the underlying mechanisms also do so.
Loading
Loading