Skip to content

Commit

Permalink
Merge branch 'ingela/ftp/polish-doc' into maint
Browse files Browse the repository at this point in the history
* ingela/ftp/polish-doc:
  Remove link from notes refering to legcy function no longer existing
  polish
  • Loading branch information
IngelaAndin committed Jun 19, 2024
2 parents b5df353 + 6bd3189 commit 0b8d3e5
Show file tree
Hide file tree
Showing 4 changed files with 97 additions and 111 deletions.
12 changes: 1 addition & 11 deletions lib/ftp/doc/guides/ftp_client.md
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
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

0 comments on commit 0b8d3e5

Please sign in to comment.