Mirrors/go-chasquid-smtp
1
0
Fork 0
mirror of https://blitiri.com.ar/repos/chasquid synced 2025-12-17 14:37:02 +00:00
Code Releases Activity

Update Go doc comments to Go 1.19's format

Browse Source 
This patch is the result of running Go 1.19's `gofmt` on the codebase,
which automatically updates all Go doc comments to the new format.

https://tip.golang.org/doc/go1.19#go-doc
This commit is contained in:
Alberto Bertogli
2022-09-02 11:11:40 +01:00
parent 7e38a877e8
commit 776bdc58ab
7 changed files with 28 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
internal/aliases/aliases.go
View File

@@ -3,8 +3,7 @@
// The resolver can parse many files for different domains, and perform // The resolver can parse many files for different domains, and perform
// lookups to resolve the aliases. // lookups to resolve the aliases.
// //
// // # File format
// File format
// //
// It generally follows the traditional aliases format used by sendmail and // It generally follows the traditional aliases format used by sendmail and
// exim. // exim.
@@ -27,8 +26,7 @@
// If the user is the string "*", then it is considered a "catch-all alias": // If the user is the string "*", then it is considered a "catch-all alias":
// emails that don't match any known users or other aliases will be sent here. // emails that don't match any known users or other aliases will be sent here.
// //
// // # Recipients
// Recipients
// //
// Recipients can be of different types: // Recipients can be of different types:
// - Email: the usual user@domain we all know and love, this is the default. // - Email: the usual user@domain we all know and love, this is the default.
@@ -37,8 +35,7 @@
// Command and arguments are space separated. No quoting, escaping, or // Command and arguments are space separated. No quoting, escaping, or
// replacements of any kind. // replacements of any kind.
// //
// // # Lookups
// Lookups
// //
// The resolver will perform lookups recursively, until it finds all the final // The resolver will perform lookups recursively, until it finds all the final
// recipients. // recipients.
@@ -46,8 +43,7 @@
// There are recursion limits to avoid alias loops. If the limit is reached, // There are recursion limits to avoid alias loops. If the limit is reached,
// the entire resolution will fail. // the entire resolution will fail.
// //
// // # Suffix removal
// Suffix removal
// //
// The resolver can also remove suffixes from emails, and drop characters // The resolver can also remove suffixes from emails, and drop characters
// completely. This can be used to turn "user+blah@domain" into "user@domain", // completely. This can be used to turn "user+blah@domain" into "user@domain",

1
internal/auth/auth.go
View File

@@ -162,6 +162,7 @@ func (a *Authenticator) Reload() error {
// DecodeResponse decodes a plain auth response. // DecodeResponse decodes a plain auth response.
// //
// It must be a a base64-encoded string of the form: // It must be a a base64-encoded string of the form:
//
// <authorization id> NUL <authentication id> NUL <password> // <authorization id> NUL <authentication id> NUL <password>
// //
// https://tools.ietf.org/html/rfc4954#section-4.1. // https://tools.ietf.org/html/rfc4954#section-4.1.

1
internal/smtp/smtp.go
View File

@@ -3,7 +3,6 @@
// //
// - Supports SMTPUTF8, via MailAndRcpt. // - Supports SMTPUTF8, via MailAndRcpt.
// - Adds IsPermanent. // - Adds IsPermanent.
//
package smtp package smtp
import ( import (

1
internal/sts/sts.go
View File

@@ -3,7 +3,6 @@
// Note that "report" mode is not supported. // Note that "report" mode is not supported.
// //
// Reference: https://tools.ietf.org/html/rfc8461 // Reference: https://tools.ietf.org/html/rfc8461
//
package sts package sts
import ( import (

10
internal/userdb/userdb.go
View File

@@ -1,7 +1,6 @@
// Package userdb implements a simple user database. // Package userdb implements a simple user database.
// //
// // # Format
// Format
// //
// The user database is a file containing a list of users and their passwords, // The user database is a file containing a list of users and their passwords,
// encrypted with some scheme. // encrypted with some scheme.
@@ -13,21 +12,18 @@
// Users must be UTF-8 and NOT contain whitespace; the library will enforce // Users must be UTF-8 and NOT contain whitespace; the library will enforce
// this. // this.
// //
// // # Schemes
// Schemes
// //
// The default scheme is SCRYPT, with hard-coded parameters. The API does not // The default scheme is SCRYPT, with hard-coded parameters. The API does not
// allow the user to change this, at least for now. // allow the user to change this, at least for now.
// A PLAIN scheme is also supported for debugging purposes. // A PLAIN scheme is also supported for debugging purposes.
// //
// // # Writing
// Writing
// //
// The functions that write a database file will not preserve ordering, // The functions that write a database file will not preserve ordering,
// invalid lines, empty lines, or any formatting. // invalid lines, empty lines, or any formatting.
// //
// It is also not safe for concurrent use from different processes. // It is also not safe for concurrent use from different processes.
//
package userdb package userdb
//go:generate protoc --go_out=. --go_opt=paths=source_relative userdb.proto //go:generate protoc --go_out=. --go_opt=paths=source_relative userdb.proto

1
test/util/minidns/minidns.go
View File

@@ -16,7 +16,6 @@
// //
// It's only meant to be used for testing, so it's not robust, performant, or // It's only meant to be used for testing, so it's not robust, performant, or
// standards compliant. // standards compliant.
//
package main package main
import ( import (