Existe alguma maneira segura de documentar uma longa cadeia de comandos com comentários para os leitores que não representam um risco para o meu sistema?
Supondo que todas as etapas estejam corretas e intencionais, finja que tenho o seguinte:
step 1
step 2
step 3
...
step 76
step 77
- this next step needs to move files to xyz so that dependency ufh will properly resolve
step 78
step 79
...
step 203
- multi-line comment which explains something really long and should be
- manually wrapped for legibility purposes.
- Oh yeah, and it is followed by a list:
- * list item 1
- * list item 2
step 204
...
step 326
- another comment but this time I contain sudo ls / for some unholy reason
step 327
...
step 435
Gostaria de copiá-lo de cima para baixo e clicar com o botão direito do mouse e colá-lo em uma sessão do PuTTY para que os comandos sejam executados sequencialmente, mas não executem algo não intencional dos comentários.
Com base em comentários e respostas, parece que é questionável se estou ou não realmente no bash shell.
echo $o
produz "-bash"
Esta é uma coisa genericamente imprudente de se fazer.
Se você estiver usando o Bash, como sugere a tag, enquanto
shopt interactive_comments
estiver ativado , poderá usar comentários reais com#
. Isso é ativado por padrão, mas pode ser desativado no shell que você está usando. Você pode ativar isso explicitamente no topo:No entanto, se você estiver preocupado com ações maliciosas , nunca deve copiar texto para o terminal . O conteúdo malicioso pode estar oculto onde você não o vê (e aqui está um exemplo funcional para tentar ) - não precisa estar em um comentário. Se você realmente tem 435 passos, ele pode estar escondido mesmo onde você o vê e você nunca vai notar.
Um script de shell real seria melhor (e os comentários definitivamente funcionarão lá), mas, novamente, se for malícia com a qual você está preocupado, você precisa revisar com muito cuidado antes de executá-lo. Copiar e colar no terminal não é confiável em nenhum caso (como mostra uma série recorrente de perguntas neste site), e seria melhor encontrar um fluxo de trabalho que não dependa disso.
Você pode adicionar comentários com segurança no meio de uma linha ou ao longo de várias linhas usando a substituição de comando. Esta resposta de estouro de pilha deve mostrar como adicionar comentários com segurança.
Para sair do seu exemplo, ficaria assim:
Você também pode consultar esta resposta , que deve ajudá-lo. Existe algum motivo para isso ser copiado e colado especificamente no PuTTY? Uma solução seria usar
scp
ou algum outro método para transferir o arquivo de script de shell para sua máquina remota e, em seguida, executar o script lá.